GET /contacts/v1/contacts/key:{contactKey}/Preferences
Retrieves consent management information from contact records by contact key. GET requests might display values that are reserved for future use and don't perform any actions at this time. Use only the parameters documented here. For best performance, use batches of contact ID values whenever possible.
| Name | Type | Description | |
|---|---|---|---|
| contactKey | string | Required | Primary address for the contact. |
| Status | Name | Type | Description |
|---|---|---|---|
| 200 | Retrieved contact preferences by contact key. | ||
| 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. | |
| 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. |
These permissions are required.
- Assets, Upload
- Assets, Publish
- Documents and Images, Read and Write
- Saved Content, Read and Write