GET /contacts/v1/contacts/key:{contactKey}/Preferences

Overview

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.

URL Parameters

Name	Type		Description
contactKey	string	Required	Primary address for the contact.

Responses

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.

Usage

These permissions are required.

Assets, Upload
Assets, Publish

Required Scope

Documents and Images, Read and Write
Saved Content, Read and Write

Example Request

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2get /contacts/v1/contacts/key:1ab2/Preferences
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response

1HTTP/1.1 200 OK
2{
3   "value":{
4      "contactID":123456,
5      "hasOptedOutTracking":false
6   },
7   "rowsAffected":1,
8   "requestServiceMessageID":"105d74f2-9eab-450f-b799-6a845ebe4a4b",
9   "responseDateTime":"2019-01-24T10:44:12.2334945-06:00",
10   "resultMessages":[
11
12   ],
13   "serviceMessageID":"0bfd9831-58cd-4db1-99bc-2f499e43a026"
14}