--- title: "Set cookie consent status" doc_type: static doc_category: static doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/ajax-api/cookie-consent' md: 'https://developer.shopline.com/docs/ajax-api/cookie-consent.md' --- # Set cookie consent status Record or update the customer's cookie consent status. After customers save their cookie preferences within a GDPR Cookie Consent banner, you can call this API to update their cookie consent status. ## Request ### API path `POST` `https://{handle}.myshopline.com/api/privacy/set_tracking_consent` > **note** > > `handle` indicates the store's unique identifier, which corresponds to the prefix of the store's domain name. For example, if a store's domain name is `open001.myshopline.com`, the store handle is `open001`. ### Request headers | **Parameter** | **Type** | **Required** | **Description** | | ------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Content-Type | String | Yes | The value of this parameter is fixed to `application/json`. | | Cookie | String | Yes | The cookies from the merchant's storefront. The value of this parameter must include the `_tracking_consent` and `_cmp_a` cookies. Both cookie values must be valid, URL-encoded JSON strings. | ### Request body | **Parameter** | **Type** | **Required** | **Description** | | ------------- | -------- | ------------ | --------------- | | preferences | Boolean | Yes | Whether to allow the use of functionality cookies.Functionality cookies allow the website to remember the username and user choices, such as country, region, and language, in order to provide a personalized experience. | | analytics | Boolean | Yes | Whether to allow the use of performance cookies.Performance cookies anonymously collect data on how the customer interacts with the website, in order to analyze and optimize website performance. | | marketing | Boolean | Yes | Whether to allow the use of targeting and advertising cookies.Targeting and advertising cookies allow advertisers to track the customer across different websites to display relevant ads and measure ad performance. | | max\_age | Integer | No | The validity period of the consent status cookies (`_tracking_consent` and `_cmp_a`). Unit: seconds.
Value range: 1-31536000
Default value: `31536000` (365 days) | ## Response ### Response headers | **Parameter** | **Type** | **Description** | | ------------- | -------- | --------------- | | Set-Cookie | String | The updated `_tracking_consent` cookie, used to record the customer's consent status. The value is a URL-encoded JSON string.
Example: `_tracking_consent=%7B%22con%22%3A%7B%22CMP%22%3A%7B%22a%22%3A%221%22%2C%22p%22%3A%221%22%2C%22s%22%3A%221%22%2C%22m%22%3A%221%22%7D%7D%2C%22lim%22%3A%5B%22GDPR%22%5D%2C%22v%22%3A%222.1%22%7D; Path=/; Max-Age=3600` | | Set-Cookie | String | The updated `_cmp_a` cookie, used to record the details of the customer's consent status. The value is a URL-encoded JSON string.
Example: `_cmp_a=%7B%22purposes%22%3A%7B%22a%22%3Atrue%2C%22p%22%3Atrue%2C%22m%22%3Atrue%2C%22t%22%3Atrue%7D%2C%22display_banner%22%3Atrue%2C%22merchant_geo%22%3A%22DE%22%2C%22sale_of_data_region%22%3Afalse%7D; Path=/; Max-Age=3600; SameSite=Lax` | ### Response body | **Parameter** | **Type** | **Description** | | ------------- | -------- | --------------- | | code | String | The response code indicating the processing result of the request. Valid values are: | | success | Boolean | Whether the API call completes successfully. | | data | Boolean | Whether the consent status cookies are updated and whether the unconsented cookies are deleted. | ## Examples ### Success example This successful request updates the `_tracking_consent` and `_cmp_a` cookies and deletes the unconsented cookies. #### Request ```bash curl --location --request POST 'https://your-handle.myshopline.com/api/privacy/set_tracking_consent' \ --header 'Content-Type: application/json' \ --header 'Cookie: _tracking_consent=%7B%22con%22%3A%7B%22CMP%22%3A%7B%22a%22%3A%221%22%2C%22p%22%3A%221%22%2C%22s%22%3A%221%22%2C%22m%22%3A%221%22%7D%7D%2C%22lim%22%3A%5B%22GDPR%22%5D%2C%22v%22%3A%222.1%22%7D; _cmp_a=%7B%22purposes%22%3A%7B%22a%22%3Atrue%2C%22p%22%3Atrue%2C%22m%22%3Atrue%2C%22t%22%3Atrue%7D%2C%22display_banner%22%3Atrue%2C%22merchant_geo%22%3A%22DE%22%2C%22sale_of_data_region%22%3Afalse%7D' \ --data-raw '{ "preferences": true, "analytics": false, "marketing": false, "max_age": 86400 }' ``` #### Response headers ```json Set-Cookie _tracking_consent=%7B%22con%22%3A%7B%22CMP%22%3A%7B%22a%22%3A%220%22%2C%22p%22%3A%221%22%2C%22s%22%3A%22%22%2C%22m%22%3A%220%22%7D%7D%2C%22lim%22%3A%5B%22GDPR%22%5D%2C%22v%22%3A%222.1%22%2C%22reg%22%3A%22GDPR%22%7D; Path=/; Max-Age=86400 Set-Cookie _cmp_a=%7B%22purposes%22%3A%7B%22a%22%3Afalse%2C%22p%22%3Atrue%2C%22m%22%3Afalse%2C%22t%22%3Afalse%7D%2C%22display_banner%22%3Atrue%2C%22merchant_geo%22%3A%22%22%2C%22sale_of_data_region%22%3Afalse%7D; Path=/; Max-Age=86400; SameSite=Lax ``` #### Response body ```json { "code": "SUCCESS", "success": true, "data": true } ``` ### Failure example 1 This request fails to update the cookie consent status because the required request body parameters (`preferences`, `analytics`, and `marketing`) are missing. #### Request ```bash curl --location --request POST 'https://your-handle.myshopline.com/api/privacy/set_tracking_consent' \ --header 'Cookie: _tracking_consent=%7B%22con%22%3A%7B%22CMP%22%3A%7B%22a%22%3A%221%22%2C%22p%22%3A%221%22%2C%22s%22%3A%221%22%2C%22m%22%3A%221%22%7D%7D%2C%22lim%22%3A%5B%22GDPR%22%5D%2C%22v%22%3A%222.1%22%7D; _cmp_a=%7B%22purposes%22%3A%7B%22a%22%3Atrue%2C%22p%22%3Atrue%2C%22m%22%3Atrue%2C%22t%22%3Atrue%7D%2C%22display_banner%22%3Atrue%2C%22merchant_geo%22%3A%22DE%22%2C%22sale_of_data_region%22%3Afalse%7D' \ --header 'Content-Type: application/json' \ --data-raw '{}' ``` #### Response body ```json { "code": "INVALID_ARGUMENT", "success": false, "data": false } ``` ### Failure example 2 This request fails to update the cookie consent status because the required cookies (`_tracking_consent` and `_cmp_a`) are missing in the request headers. #### Request ```bash curl --location --request POST 'https://your-handle.myshopline.com/api/privacy/set_tracking_consent' \ --header 'Content-Type: application/json' \ --header 'Cookie: ' \ --data-raw '{ "preferences": true, "analytics": false, "marketing": false, "max_age": 86400 }' ``` #### Response body ```json { "code": "COOKIE_INVALID", "success": false, "data": false } ```