DocumentationCampaign Standard Documentation

Managing CCPA opt-out managing-ccpa-optout

Last update: Mon Feb 07 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

A profile’s CCPA opt-out status can be monitored and managed using the ccpaOptOut profile attribute and the “true” or “false” values:

"ccpaOptOut": <value>

  • true: forbids the sale of personal information.
  • false: authorizes the sale of personal information.

Sample requests

  • Sample GET request to retrieve a profile’s CCPA opt-out status.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profilesAndServices/profile/<PKEY> \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8'

    Response to the GET request.

    code language-none 
    
{
"PKey": "<PKEY>",
  "ccpaOptOut": false,
  "firstName": "John",
  "lastName": "Doe",
...
}

  • Sample POST request to mark a profile for CCPA opt-out.

    code language-none 
    
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/profilesAndServices/profile/ \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8'
-i
-d {
-d  "firstName": "John",
-d  "lastName": "Doe",
-d  "email": "jdoe@mail.com",
-d  "ccpaOptOut": true
-d }'

    Response to the GET request.

    code language-none 
    
{
    ...
    "email": "john.doe@mail.com",
    "firstName": "John",
    "lastName": "Doe",
    "ccpaOptOut": true,
    ...
}

  • Sample PATCH request to update a profile for CCPA opt-out.

    code language-none 
    
-X PATCH https://mc.adobe.io/<ORGANIZATION>/campaign/profilesAndServices/profile/<PKEY> \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-H 'Content-Type: application/json;charset=utf-8'
-i
-d {
-d  "ccpaOptOut": true
-d }'

    Response to the GET request.

    code language-none 
    
{
    ...
    "email": "john.doe@mail.com",
    "firstName": "John",
    "lastName": "Doe",
    "ccpaOptOut": true,
    ...
}
recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff