updateSiteProperties
put
/ccagent/v1/profiles/{id}/siteProperties
Update site properties for specific customer. Example: Update receive email property with yes or no for specic site
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
The customer profile id.
Root Schema : updateSiteProperties_request
Type:
Show Source
object
-
siteProperties:
object siteProperties
The site related properties
Example:
{
"siteProperties":[
{
"site":{
"id":"SiteA"
},
"properties":{
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"yes"
}
}
]
}
Nested Schema : siteProperties
Type:
object
The site related properties
Show Source
-
properties:
object properties
The type of the site property.
-
site:
string
The ID of the site.
Nested Schema : properties
Type:
object
The type of the site property.
Show Source
-
GDPRProfileP13nConsentGranted:
boolean
Indicates whether the customer has given consent for his/her profile information to be used for personalization purposes. Can be true or false.
-
receiveEmail:
string
Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
-
repositoryId:
string
The ID of the repository of site property.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateSiteProperties_response
Type:
Show Source
object
-
items:
array items
The site related properties
-
limit:
integer
The batch size of the records to be fetched together.
-
offset:
integer
The start index of the list of records to be fetched.
-
sort:
string
Sorting format.
Nested Schema : items
Type:
Show Source
object
-
properties:
object properties
The type of the site property.
-
site:
object site
The site.
Nested Schema : properties
Type:
object
The type of the site property.
Show Source
-
GDPRProfileP13nConsentDate:
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted:
boolean
Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.
-
receiveEmail:
string
Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.
-
receiveEmailDate:
string
The date on which the customer opted for receiving marketing emails.
-
repositoryId:
string
The ID of the repository of site property.
Example Response (application/json)
{
"totalResults":1,
"endingIndex":250,
"offset":0,
"totalResultsParam":true,
"count":1,
"limit":250,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/profiles/se-570031/siteProperties"
}
],
"sort":null,
"items":[
{
"site":{
"id":"SiteA"
},
"properties":{
"GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"yes",
"receiveEmailDate":"2018-03-21T13:10:08.463Z"
}
}
],
"listingRequest":{
"endingIndex":250,
"correctedView":null,
"queryOptions":{
"precachedPropertyNames":null,
"doNotCacheQuery":false,
"sortDirectives":null,
"endingIndex":250,
"ignoreDuplicates":false,
"nthIndex":1,
"uncachedItems":false,
"uncachedItemsSet":false,
"startingIndex":0
},
"rqlString":null,
"QErrorCodeMap":null,
"QPropertyAliasMap":null,
"sort":null,
"startingIndex":0,
"QIgnoreCase":true,
"QString":null,
"filterProperties":[
"displayName",
"id"
],
"includeRqlInQueryGeneration":true,
"rqlStatement":null,
"expanded":false,
"scimParser":null,
"useSCIMForQ":true,
"limit":250,
"siteId":null,
"after":null,
"calculateTotalAvailable":true
},
"startingIndex":0,
"totalNumberOfItems":1
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|200012|please provide valid input|
|23010|City not specified in shipping address|
|23011|Address line 1 not specified in shipping address|
|22000|The profile id passes is null or empty.|
|23012|No last name specified in shipping address|
|22001|Internal error while getting the profile.|
|23013|No first name specified in shipping address|
|22002|No profile found with the given id.|
|23015|Phone number not specified in shipping address|
|23005|Invalid phone number in shipping address|
|23007|No country specified in shipping address|
|23008|Postal code not specified in shipping address|
|22024|{0}({1}) must be a String|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code