PUT api/Product

Updates a product.

Request Information

URI Parameters

None.

Body Parameters

UpdateProductModel
NameDescriptionTypeAdditional information
Id

Product's unique identifier. Only used to find the product, not to be updated.

 globally unique identifier

None.
Name

The product name as the user will see it.

 string

Required
Code

I don't know!

 string

Required
Abbreviation

Not really sure, for the most part it looks the same as Name.

 string

Required
Active

Only active products shown to end users. Required.

 boolean

Required
Exempt

Exempt products don't apply to CCPa law. Required.

 boolean

Required
TrustArcFormId

Not required.

 globally unique identifier

None.
ClientSystemId

Required.

 globally unique identifier

Required
IDologyEnterpriseId

Required.

 globally unique identifier

Required
SubCategoryId

Not required.

 globally unique identifier

None.
ModifiedBy

An identifier for the user that altered this product.

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "Id": "095671e9-839d-488d-8564-515876949b58",
  "Name": "sample string 2",
  "Code": "sample string 3",
  "Abbreviation": "sample string 4",
  "Active": true,
  "Exempt": true,
  "TrustArcFormId": "3369e1d0-b034-4938-9c6f-88f23e5c1aa7",
  "ClientSystemId": "150da0e2-113c-4735-9061-02bebb49fc12",
  "IDologyEnterpriseId": "4f9d2ca8-a0a0-4b63-95f3-56b949b30fc9",
  "SubCategoryId": "eb462380-5922-4e93-9626-6adac4dd5d7f",
  "ModifiedBy": "sample string 7"
}

text/xml

Sample: 
<UpdateProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Product">
  <Abbreviation>sample string 4</Abbreviation>
  <Active>true</Active>
  <ClientSystemId>150da0e2-113c-4735-9061-02bebb49fc12</ClientSystemId>
  <Code>sample string 3</Code>
  <Exempt>true</Exempt>
  <IDologyEnterpriseId>4f9d2ca8-a0a0-4b63-95f3-56b949b30fc9</IDologyEnterpriseId>
  <ModifiedBy>sample string 7</ModifiedBy>
  <Name>sample string 2</Name>
  <SubCategoryId>eb462380-5922-4e93-9626-6adac4dd5d7f</SubCategoryId>
  <TrustArcFormId>3369e1d0-b034-4938-9c6f-88f23e5c1aa7</TrustArcFormId>
  <Id>095671e9-839d-488d-8564-515876949b58</Id>
</UpdateProductModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample: 
true

text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>