POST /contacts/v1/contacts/preferences

Overview

Adds consent management information to contact records for data protection and privacy concerns. The request can include multiple contact IDs in a single JSON payload. For best performance, use batches of contact ID values whenever possible.

JSON Parameters

Name	Type		Description
items	array	Required	Array of contact IDs and other properties to add.
items.contactID	long	Required	Unique ID for the contact.
items.hasOptedOutTracking	boolean		Indicates whether a contact opted out of tracking information.

Responses

Status	Name	Type	Description
200			Added contact preferences.
	items	array	Array of contact IDs and other properties to add.
	items.contactID	long	Unique ID for the contact.
	items.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 these permissions.

Contacts | Read
Contacts | Write
Contacts | Access

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/preferences
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
   "items":[
      {
         "contactID":45678,
         "hasOptedOutTracking":false
      },
      {
         "contactID":12345,
         "hasOptedOutTracking":false
      }
   ]
}

Example Response

HTTP/1.1 200 OK

{
   "items":[
      {
         "contactID":45678,
         "hasOptedOutTracking":false
      },
      {
         "contactID":12345,
         "hasOptedOutTracking":false
      }
   ],
   "rowsInserted":2,
   "rowsUpdated":0,
   "rowsDeleted":0,
   "requestServiceMessageID":"4d08d1ff-1377-4f7b-9afe-937e3805c67f",
   "responseDateTime":"2019-01-22T16:17:32.0041492-06:00",
   "resultMessages":[

   ],
   "serviceMessageID":"47ec0720-81d1-4fee-8e03-d8a9d42af1c1"
}