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
Path Parameters
Body ()
Root Schema : updateSiteProperties_request
Type: object
Show Source
Example:
{
    "siteProperties":[
        {
            "site":{
                "id":"SiteA"
            },
            "properties":{
                "GDPRProfileP13nConsentGranted":true,
                "receiveEmail":"yes"
            }
        }
    ]
}
Nested Schema : siteProperties
Type: object
The site related properties
Show Source
Nested Schema : properties
Type: object
The type of the site property.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateSiteProperties_response
Type: object
Show Source
Nested Schema : items
Type: array
The site related properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The type of the site property.
Show Source
Nested Schema : site
Type: object
The site.
Show Source
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|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top