POST /contacts/v1/contacts/preferences/search?ReferenceType={ReferenceType}

Overview

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.

Usage

This action requires these permissions.

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
2POST /contacts/v1/contacts/preferences/search?ReferenceType=2
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN
5
6{
7  "items": [
8    12345
9  ]
10}

Example Response

1HTTP/1.1 200 OK
2{
3   "items":[
4      {
5         "contactID":12345,
6         "hasOptedOutTracking":false
7      }
8   ],
9   "rowsAffected":1,
10   "requestServiceMessageID":"d613f535-eea8-435e-a59c-59ec6ab4bebd",
11   "responseDateTime":"2019-01-23T15:04:14.7305707-06:00",
12   "resultMessages":[
13
14   ],
15   "serviceMessageID":"29029de0-abe4-4216-985d-4a8d78883dfa"
16}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!