POST /contacts/v1/contacts/preferences/search?ReferenceType={ReferenceType}
Searches for consent management information in contact records by reference type. For best performance, use batches of contact ID values whenever possible.
URL Parameters
| Name | Type | | Description |
|---|
| ReferenceType | integer | Required | For contact key, use 1. For contact ID, use 2. |
JSON Parameters
| Name | Type | | Description |
|---|
| items | array | Required | Array of contact IDs or contact keys to search. |
Responses
| Status | Name | Type | Description |
|---|
| 200 | | | Searched contact preferences by reference type. |
| | 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. |
| | rowsAffected | integer | Number of rows returned. |
| | 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. |
Required Marketing Cloud Permissions
- Assets, Upload
- Assets, Publish
Required Scope
- Documents and Images, Read and Write
- Saved Content, Read and Write
Example Request
Example Response