Adds consent management information to contact records by contact ID for data protection and privacy concerns.
URL Parameters
| Name |
Type |
|
Description |
| contactId |
string |
Required |
Unique ID for the contact. |
JSON Parameters
| Name |
Type |
|
Description |
| value |
object |
Required |
Array of contact IDs and other properties to add. |
| value.contactID |
long |
Required |
Unique ID for the contact. |
| value.hasOptedOutTracking |
boolean |
|
Indicates whether a contact opted out of tracking information. |
Responses
| Status |
Name |
Type |
Description |
| 200 |
|
|
Added contact preferences by contact ID. |
| |
value |
object |
Contains the contact ID and other properties to add. |
| |
value.contactID |
long |
Unique ID for the contact. |
| |
value.hasOptedOutTracking |
boolean |
Indicates whether a contact opted out of tracking information. |
| |
rowsInserted |
integer |
Number of preferences inserted. |
| |
rowsUpdated |
integer |
Number of preferences updated. |
| |
rowsDeleted |
integer |
Number of preferences deleted. |
| |
requestServiceMessageID |
guid |
Service message ID for the request. |
| |
responseDateTime |
integer |
Date and time of the retry response in UTC. |
| |
resultMessages |
array |
Array of messages about the request. Includes details, such as resulttype and resultcode, about a bad request. |
| |
serviceMessageID |
guid |
Service message ID for the response. |
Usage
To issue a request, you must have the Assets | Upload and Assets | Publish permissions.
Required Scope
- Documents and Images, Read and Write
- Saved Content, Read and Write
Example Request
Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /contacts/v1/contacts/id:1234/Preferences
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
{
"value":{
"contactID":1234,
"hasOptedOutTracking":false
}
}
Example Response
HTTP/1.1 200 OK
{
"value":{
"contactID":1234,
"hasOptedOutTracking":false
},
"rowsInserted":1,
"rowsUpdated":0,
"rowsDeleted":0,
"requestServiceMessageID":"1e17845f-d020-48a8-8621-c318c964b5a6",
"responseDateTime":"2019-01-24T11:37:13.1845624-06:00",
"resultMessages":[
],
"serviceMessageID":"a5866bea-02a0-4989-bd1d-7edd4dd95519"
}
