Consent Write

All records with the email address listed are updated. If the Create Individual parameter is selected and no Individual record exists, the API creates an Individual record. If warranted, the API also creates a Contact Point Type Consent and Contact Point Email record.

If you aren’t passing anything in the request body, pass in an empty object {}.

Syntax

URI: /services/data/vXX.X/consent/action/action?ids=listOfIds

Formats: JSON

HTTP methods: PATCH

Authentication: Authorization: Bearer token

Request parameters

Action

Allowed values are:

• email
• fax
• geotrack
• mailing
• phone
• portability
• process
• profile
• shouldForget
• social
• solicit
• storePiiElsewhere
• track
• web

Security

To call the Consent Write API, you must have either the ModifyAllData or the ConsentApiUpdate user permission. This API writes org-wide consent data, such as links between records and the value of consent flags, and not just records to which the user ordinarily has access. The ConsentApiUpdate user permission grants full write permission to the user during the Consent Write API call.

Example

Example Request

1curl -X PATCH https://MyDomainName.my.salesforce.com/services/data/v67.0/consent/action/<action>?ids=<email-OR-recordID>&status=<optout/optin/seen/notseen>&createIndividual=<true/false> -H "Content-Type: application/json" -d "@exampleRequestBody.json"

Example Request Body

1{ "ids": [ "001ZM000002ZhpHYAS", "001ZM000002ZhpFYAS" ] }

Example Response Body

1{
2  "<email-OR-recordID>" : {
3    "result" : "Success",
4    "edited" : [{
5      "objectType" : "<Contact, Lead, User, etc.>",
6      "field" : "<HasOptedOutofFax, DoNotCall,etc>",
7      "valueOfField" : "<true/false>",
8      "id" : "<recordID>"
9    }],
10  }
11}