The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

POST /contacts/v1/contacts/preferences

Adds consent management information to contact records for data protection and privacy concerns. The request can include multiple contact IDs in a single JSON payload. For best performance, use batches of contact ID values whenever possible.

NameTypeDescription
itemsarrayRequiredArray of contact IDs and other properties to add.
items.contactIDlongRequiredUnique ID for the contact.
items.hasOptedOutTrackingbooleanIndicates whether a contact opted out of tracking information.
StatusNameTypeDescription
200  Added contact preferences.
 itemsarrayArray of contact IDs and other properties to add.
 items.contactIDlongUnique ID for the contact.
 items.hasOptedOutTrackingbooleanIndicates whether a contact opted out of tracking information.
 rowsInsertedintegerNumber of preferences inserted.
 rowsUpdatedintegerNumber of preferences updated.
 rowsDeletedintegerNumber of preferences deleted.
 requestServiceMessageIDguidService message ID for the request.
 responseDateTimeintegerDate and time of the retry response in UTC.
 resultMessagesarrayArray of messages about the request. Includes details, such as resulttype and resultcode, about a bad request.
 serviceMessageIDguidService message ID for the response.

To issue a request, you must have these permissions.

  • Contacts | Read
  • Contacts | Write
  • Contacts | Access
  • Documents and Images, Read and Write
  • Saved Content, Read and Write