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.

Usage

Required Marketing Cloud Permissions

  • Assets, Upload
  • Assets, Publish

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/search?ReferenceType=2
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "items": [
    12345
  ]
}

Example Response

HTTP/1.1 200 OK
{  
   "items":[  
      {  
         "contactID":12345,
         "hasOptedOutTracking":false
      }
   ],
   "rowsAffected":1,
   "requestServiceMessageID":"d613f535-eea8-435e-a59c-59ec6ab4bebd",
   "responseDateTime":"2019-01-23T15:04:14.7305707-06:00",
   "resultMessages":[  

   ],
   "serviceMessageID":"29029de0-abe4-4216-985d-4a8d78883dfa"
}
Last Updated: Jun 8, 2021