j
WhatsApp Session Message API
1.0.0
Create and manage WhatsApp session message content and renditions. Session messages support text, media, location requests, and interactive buttons.
This table lists the WhatsApp session message-related use cases that the API supports.
| Supported Use Case | HTTP Verb | URI |
|---|---|---|
| Create WhatsApp session message content | POST | /services/data/{apiVersion}/connect/cms/contents/whatsappSession |
| Get WhatsApp session message content | GET | /services/data/{apiVersion}/connect/cms/contents/{contentId} |
| Create a WhatsApp message rendition | POST | /services/data/{apiVersion}/connect/cms/renditions/whatsappMessage |
| Update a WhatsApp session message content variant | PUT | /services/data/{apiVersion}/connect/cms/contents/variants/{variantId} |
| Delete a WhatsApp session message content variant | DELETE | /services/data/{apiVersion}/connect/cms/contents/variants/{variantId} |
WhatsApp Session Content Structure
The WhatsApp session content type uses a block-based architecture, shown in this example:
{
"sfdc_cms:title": "WhatsApp Session Message",
"messageType": "Text",
"contentBlock": {
"type": "block",
"definition": "sfdc_cms__whatsappMessageTypeText",
"attributes": {
"sfdc_cms:whatsappMessageBody": "Hello, welcome!",
"type": "Text"
}
}
}
Content Properties
| Property | Type | Description |
|---|---|---|
sfdc_cms:title |
text | Required. The name of the content item. |
messageType |
enum | Required. The message type. See Message Types. |
description |
multiline text | A description of the content type. |
sfdc_cms:whatsappMessageBody |
body | The body text of the message. |
Message Types
WhatsApp session messages can be one of these message types:
- Text—A plain text message with body content.
- Image—A message with an image attachment. Can include a link and a caption.
- Video—A message with a video attachment. Can include a link and a caption.
- Document—A message with a document attachment. Can include a link.
- Audio—A message with an audio attachment.
- Location Request—A request for the recipient's location.
- CTA URL Button—A call-to-action button with URL, footer, and button sub-blocks.
Content Block Definitions
Each message type maps to a specific block definition:
- Text messages map to
sfdc_cms__whatsappMessageTypeText - Image messages map to
sfdc_cms__whatsappMessageTypeImage - Video messages map to
sfdc_cms__whatsappMessageTypeVideo - Document messages map to
sfdc_cms__whatsappMessageTypeDocument - Audio messages map to
sfdc_cms__whatsappMessageTypeAudio - Location Request messages map to
sfdc_cms__whatsappMessageTypeLocationRequest - CTA URL Button messages map to
sfdc_cms__whatsappMessageTypeCtaUrlButton
Data Providers
WhatsApp session messages support these data providers for personalization:
sfdc_cms__linkDataProvider—Link data (PreferenceCenterUrl)sfdc_cms__unifiedIndividualDataProvider—Unified Individual profile datasfdc_cms__eventListDataProvider—Event list datasfdc_cms__organizationDataProvider—Organization datasfdc_cms__activationListDataProvider—Activation list datasfdc_cms__apexClassListDataProvider—Apex class list datasfdc_cms__couponListDataProvider—Coupon list data
Handlebars Expression Support
WhatsApp session message content supports Handlebars scripting in message body fields.
https://{subdomain}.my.salesforce.com
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!