Update the Consent Status
Updates the consent status of the messaging end user for the specified conversation channel.
This API applies to the following product:
- Bring Your Own Channel for Contact Center as a Service
This API is available in version 62.0 and later.
v1/consent
PATCH
Authorization: Bearer <Salesforce access token>
String. Standard header. The authorization token, where \<token\> is the JSON Web Token (JWT). Required.
Content-Type: <Request body format>
String. Standard header. The format of the request body. Valid format is multipart/form-data. Required.
OrgId: <Salesforce Org Id>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.
AuthorizationContext: <ConversationChannel Definition developer name>
String. Standard header. The ConversationChannelDefinition developer name in the format {prefix}_{ConversationChannelDefinitionName}. The prefix must match the developer name prefix of the corresponding connected app. For example, Partner1_ChannelDefinition1. Required.
RequestId: <GUID>
String. Standard header. A globally unique ID (GUID). Required.
For example,
| Property Name | Type | Description | Required |
|---|---|---|---|
| endUserClientId | string | The end user client identifier. This value comes from the partner system and can be up to 240 characters long. | Yes |
| channelAddressIdentifier | string | The globally unique ID for the conversation channel. This value comes from the MessagingChannel.channelAddressIdentifier standard object field. | Yes |
| consentStatus | The end user’s consent status. Valid values include: -ImplicitlyOptedIn - Sending the company a message automatically indicates the end user’s consent to receive messages from this channel. - ExplicitlyOptedIn - The end user explicitly consents to receive messages from this channel. -DoublyOptedIn - The end user explicitly consents to receive messages from this channel, and then confirms their consent. - OptedOut - The end user sends a keyword, such as STOP, to opt out of receiving messages. | Yes |
- GitHub: Interaction Service APIs