# Publishing Template API V3 — Developer Guide

**Applies to:** Sprinklr Publishing Template APIs V3

**V2 API reference:** [Publishing Template](https://legacy-dev.sprinklr.com/publishing-template)

## 1. Overview

Publishing templates let you send **structured, interactive private messages** — quick replies, carousels, cards, list pickers, forms, appointment and payment requests — instead of plain text. You choose a template by setting the `type` field on the `attachment` object inside the message content. The channel determines which template types are valid.

All publishing templates in V3 are sent through a **single endpoint**.

📖 Related Knowledge Base Article: [Publishing Template](https://www.sprinklr.com/help/categories/service-channels/65255c156e5c735ec130e74a)

### 1.1 Channel and Template-type Support Matrix

Template availability is documented per channel. A type that is valid on one channel is not automatically valid on another.

| Channel | Channel Type | Documented Template Types |
|  --- | --- | --- |
| Facebook | `FACEBOOK` | `QUICK_REPLY`, `BUTTON_TEMPLATE`, `CAROUSEL` |
| Instagram | `INSTAGRAM` | `QUICK_REPLY`, `CAROUSEL` |
| Twitter | `TWITTER` | `QUICK_REPLY` |
| WhatsApp | `WHATSAPP_BUSINESS` | `LIST_PICKER`, `CARD` (plain / image / video / document header), `GEO_LOCATION`, `REQUEST_LOCATION`, `ADDRESS`, `CTA_URL` |
| Apple Business Chat | `APPLE_BUSINESS_CHAT` | `RICH_LINK`, `LIST_PICKER`, plain text (no attachment), `AUTHENTICATION`, `QUICK_REPLY`, `TIME_PICKER`, `APP_LINK`, `APPLE_PAY`, `FORM` |
| Sprinklr Live Chat | `SPRINKLR_LIVE_CHAT` | `CARD`, `QUICK_REPLY`, `CAROUSEL`, `PRODUCT_LIST`, `APPOINTMENT`, `SURVEY`, `SECURE_FORM`, `RICH_TEXT_CAROUSEL` |


## 2. API Endpoint(s)

https://api3.sprinklr.com/{env}/api/v3/publishing/message

## 3. Base URLs and Environments

**All API calls are sent to the production endpoint:**

```http
https://api3.sprinklr.com/{env}/api/v3
```

So the resource in production is:

```http
https://api3.sprinklr.com/{env}/api/v3/publishing/message
```

Replace {env} with your assigned environment identifier (prod0, prod2, prod11, and so on — see [APIs | Sprinklr Developer Portal](https://legacy-dev.sprinklr.com/apis) for the environment list).

## 4. Authentication and Common Headers

API headers include the mandatory information you send along with the request URL and body. This information helps provide insights into request context and authorization credentials that, in turn, allows access to protected resources.

| Header | Value | Description |
|  --- | --- | --- |
| `Authorization` | `Bearer {token}` | Authenticates the user with the server. |
| `Key` | `{api-key}` | Authenticates the application with the server. |
| `Content-Type` | `application/json` | Identifies the request-body media type. |
| `Accept` | `application/json` | Identifies the expected response type. |


## 5. Channel Reference

All payloads below are **illustrative**. Credentials are placeholders.

### 5.1 Sprinklr Live Chat Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists Sprinklr Live Chat templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for "channelType": "SPRINKLR_LIVE_CHAT".

For Sprinklr Live Chat, you can use this API to publish the following message types:

- Publishing CARD
- Publishing QUICK_REPLY
- Publishing CAROUSEL
- Publishing PRODUCT_LIST
- Publishing APPOINTMENT
- Publishing SURVEY
- Publishing SECURE_FORM
- Publishing RICH_TEXT_CAROUSEL


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

#### Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
accountId
Required
Unique Id of the Live Chat account.
Dev Notes: 
You can derive the accountId from the Live Chat app ID.
For example, if the Live Chat app ID is app_12345, then accountId = 12345.
Integer
content
Required
Contains message details.
Object
title
Optional
Title of the message.
String
text
Optional
Text of the message.
String
attachment
Required
Attachment object containing type-specific parameters.
Supported Types:
CARD
QUICK_REPLY
CAROUSEL
PRODUCT_LIST
APPOINTMENT
SURVEY
SECURE_FORM
RICH_TEXT_CAROUSEL
For more details on the parameters of each attachment type, refer to the 
Attachment Object Parameters
table below.
Object
scheduleDate
Optional
Date/time to schedule the message
Integer
taxonomy
Required
Object containing campaign and custom property details
Object
campaignId
Required
Campaign identifier to associate the message
String
clientCustomProperties
Optional
Client custom properties for the message
Object
partnerCustomProperties
Optional
Partner custom properties for the message
Object
inReplyToMessageId
Required
The message ID being replied to.
String
approval
Optional
Type of approval to process.
Default Value
: NONE
Supported Values
: ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE
Object
toProfile
Required
Profile details for the recipient.
Object
channelType
Required
Channel type. In this case, use SPRINKLR_LIVE_CHAT.
String
channelId
Required
Channel identifier of the profile.
String
screenName
Required
Screen name of the profile.
String
tags
Optional
Tags to be added to the message.
String
urlShortenerId
Optional
URL shortener identifier to apply to the message.
String
#### Attachment Object Parameters

Use the links below to navigate to the parameter tables for each attachment type.

- CARD
- QUICK_REPLY
- CAROUSEL
- PRODUCT_LIST
- APPOINTMENT
- SURVEY
- SECURE_FORM
- RICH_TEXT_CAROUSEL


#### 5.1.1 CARD Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use CARD
String
title
Required
Title of the card
String
description
Optional
Description of the Live Chat template
String
previewImageUrl
Required
Preview image URL
String
disableManualResponse
Required
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Default:
false
Supported Values:
true, false
Boolean
buttons
Required
Array of button objects.
Array
buttons[]
id
Required
Unique identifier for the button
String
title
Required
Title of the button
String
subtitle
Optional
Subtitle text for the button
String
payload
Optional
Payload data associated with the button
String
buttons[].actionDetail
action
Required
Action type. For CARD, possible actions include:
TEXT
OPEN_URL (requires url property, e.g., "url":"www.google.com")
String
**Dev Notes:**

- "action" : "OPEN_URL" is used to redirect the user to another page on the web when they click on it.
- For adding bold text in title and description, you can use the following tags: <p style="margin: 0;1"> <strong> Title/Description </strong> </p>


#### 5.1.2 QUICK_REPLY Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use QUICK_REPLY.
String
title
Required
Title of the quick reply
String
previewImageUrl
Required
Preview image URL
String
disableManualResponse
Required
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Default:
false
Supported Values:
true, false
Boolean
quickReplies
Required
Array of quick reply button objects
Array
quickReplies[]
id
Required
Unique identifier for the quick reply button
String
title
Required
Title of the quick reply button
String
subtitle
Optional
Subtitle text for the quick reply button
String
payload
Optional
Payload data associated with the quick reply button
String
quickReplies[].actionDetail
action
Required
Action type. For QUICK_REPLY, the possible action is TEXT
String
#### 5.1.3 CAROUSEL Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
attachment
Required
Defines the attachment object
Object
type
Required
Type of attachment. For this template, use CAROUSEL.
String
disableManualResponse
Required
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Default:
false
Supported Values:
true, false
Boolean
cardAttachmentList
Required
Array of CARD objects. See Card Attachment List table below.
Array
cardAttachmentList[].CARD
type
Required
Use CARD for carousel items.
String
title
Required
Title of the card
String
previewImageUrl
Optional
Image URL for the card
String
buttons
Required
Object containing details about the button
Array
buttons[]
id
Required
Unique identifier for the button
String
title
Required
Title of the button
String
subtitle
Optional
Subtitle text for the button
String
payload
Optional
Payload data associated with the button
String
buttons[].actionDetail
action
Required
Action type. For CAROUSEL, the possible action is TEXT
String
#### 5.1.4 PRODUCT_LIST Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use PRODUCT_LIST.
String
cardAttachmentList
Required
Array of CARD objects representing products
Array
cardAttachmentList[].CARD
title
Required
Title of the product card
String
previewImageUrl
Required
Image URL for the product card
String
type
Required
Always CARD for product list items
String
buttons
Required
CTA buttons with action details
Array
buttons[]
title
Required
Label for the button
String
buttons[].actionDetail
url
Required
URL to open when the button is clicked
String
target
Optional
Target behavior (for example, _blank)
String
action
Required
Action type (for example, OPEN_URL)
String
description
Optional
Description of the product list
String
disableManualResponse
Optional
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Supported Values:
true, false
Boolean
otherConfigs
Optional
Object containing additional configuration
Object
layoutType
Optional
Layout type (for example, IMAGE_TOP)
String
screenReaderLabel
Optional
Accessibility label for screen readers
String
#### 5.1.5 APPOINTMENT Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use APPOINTMENT.
String
selectDateTitle
Required
Title shown for selecting a date
String
selectTimeTitle
Required
Title shown for selecting a time
String
selectDatePlaceholder
Optional
Placeholder text for date selection
String
submitDateTitle
Optional
Title shown on submit date button
String
numDays
Optional
Number of days available for selection
Integer
dateFormat
Optional
Date format to display (for example, MMM D YYYY)
String
submit
Required
Object containing submit button details
Object
id
Required
Unique identifier for submit button
String
title
Required
Title of the submit button
String
postSubmit
Optional
Object containing post-submit button details
Object
id
Optional
Unique identifier for post-submit button
String
title
Optional
Title of the post-submit button
String
slotDefinitionConfigId
Required
Configuration ID for slot definition
String
showSubmittedContent
Optional
Flag to show submitted content after submission
Boolean
disableManualResponse
Optional
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Supported Values:
true, false
Boolean
postSubmitTitle
Optional
Title shown after submission
String
fromFirstAvailableSlot
Optional
Flag to start from first available slot
Boolean
#### 5.1.6 SURVEY Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use SURVEY.
String
title
Required
Title of the survey
String
description
Optional
Description text for the survey
String
disableManualResponse
Optional
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Supported Values:
true, false
Boolean
postSubmitTitle
Optional
Title shown after submission
String
screenReaderLabel
Optional
Accessibility label for screen readers
String
surveyButton
Required
Object containing survey button details
Object
id
Required
Unique identifier for the survey button
String
title
Required
Title of the survey button
String
postSubmit
Optional
Object containing post-submit button details
Object
id
Optional
Unique identifier for the post-submit button
String
title
Optional
Title of the post-submit button
String
showSubmittedContent
Optional
Flag to show submitted content after survey completion
Boolean
#### 5.1.7 SECURE_FORM Attachment Request Parameters

You can send Secure Forms to safely collect sensitive or confidential information from customers. These forms ensure data is shared with agents within a protected, controlled environment.

| **Parameter** | **Sub-Parameter** | **Required/Optional** | **Description** | **Type** |
|  --- | --- | --- | --- | --- |
| type |  | Required | Type of attachment. For this template, use SECURE_FORM. | String |
| form |  | Required | Object containing the form details. | Object |
|  | formTitle | Required | Title of the secure form | String |
|  | fields | Required | Array of field objects | Array |
|  | fields.name | Required | Label or name of the form field | String |
|  | fields.type | Required | Type of the form field (e.g., EMAIL) | String |
| submit |  | Required | Object containing submit button details | Object |
|  | title | Required | Title of the submit button | String |
|  | actionDetail | Required | Object containing action details | Object |
|  | actionDetail.postBackHandlerType | Required | Handler type for secure form post-back (SECURE_FORM_POST_BACK) | String |
|  | actionDetail.action | Required | Action type. For example, POST_BACK. | String |


#### 5.1.8 RICH_TEXT_CAROUSEL Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this template, use RICH_TEXT_CAROUSEL.
String
disableManualResponse
Required
Prevents customers from sending free‑form messages while interacting with this template. When enabled, users can only respond using predefined options until the brand sends the next message.
Default:
false.
Supported Values:
true, false.
Boolean
cardAttachmentList
Required
Array of CARD objects displayed in the carousel.
Array
cardAttachmentList[].CARD
type
Required
Always CARD for carousel items.
String
title
Required
Title of the card.
String
previewImageUrl
Optional
Image URL for the card.
String
buttons
Optional
Array of button objects.
Array
buttons[]
id
Required
Unique identifier for the button.
String
title
Required
Title of the button.
String
subtitle
Optional
Subtitle text for the button.
String
payload
Optional
Payload data associated with the button.
String
buttons[].actionDetail
action
Required
Action type. For RICH_TEXT_CAROUSEL, the possible action is TEXT.
String
screenReaderLabel
Optional
Accessibility label for screen readers.
String
### Request Examples

The following examples show how to publish dynamic Live Chat templates using the Publishing API.

- **CARD**
- **QUICK_REPLY**
- **CAROUSEL**
- **PRODUCT_LIST**
- **APPOINTMENT**
- **SURVEY**
- **SECURE_FORM**
- **RICH_TEXT_CAROUSEL**


#### CARD

**Example - Request**

```bash
 
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66001821,
    "content": {
      "title": "product_card",
      "text": "checl",
      "attachment": {
        "type": "INFO_CARD",
        "cardAttachmentList": [
          {
            "title": "image_title",
            "description": "<p dir=\"auto\" style=\"margin: 0;\">desc_card_product</p>",
            "previewImageUrl": "https://example-5nf193uwjec2.com/resource/3",
            "type": "CARD"
          }
        ],
        "buttons": [
          {
            "id": "ca74ef73-99c5-4a0b-9d43-db0faf233fe2",
            "title": "cta",
            "actionDetail": {
              "url": "https://www.sprinklr.com",
              "target": "_blank",
              "action": "OPEN_URL"
            }
          }
        ],
        "description": "message for card",
        "disableManualResponse": true,
        "screenReaderLabel": "reader"
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66085334_1786437461000_FACEBOOK_14_1215182290622248_2030445457834952",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example - Response**

```bash
 {
  "data": [
    "POST_593681892"
  ],
  "errors": []
}
```

#### QUICK_REPLY

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66216478,
    "content": {
      "title": "",
      "text": "text",
      "attachment": {
        "type": "QUICK_REPLY",
        "message": "title",
        "disableManualResponse": false,
        "quickReplies": [
          {
            "id": "",
            "title": "title of button",
            "subtitle": "subtitle of button",
            "payload": "payload",
            "actionDetail": {
              "action": "TEXT"
            }
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_8125",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66216478_1701165600000_SPRINKLR_LIVE_CHAT_313_6a22874219af3a65dbda4d28",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "68a36a9e97724224b7df5b75",
      "screenName": "UdyanTest"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_593681894"
  ],
  "errors": []
}
```

#### CAROUSEL

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66216478,
    "content": {
      "title": "CarouselTest",
      "text": "outside text",
      "attachment": {
        "type": "CAROUSEL",
        "disableManualResponse": false,
        "cardAttachmentList": [
          {
            "type": "CARD",
            "title": "Card 1",
            "previewImageUrl": "",
            "buttons": [
              {
                "id": "1234",
                "title": "Button 1",
                "subtitle": "",
                "payload": "",
                "actionDetail": {
                  "action": "TEXT"
                }
              }
            ]
          },
          {
            "type": "CARD",
            "title": "Card 2",
            "previewImageUrl": "",
            "buttons": [
              {
                "id": "8907",
                "title": "Button 2",
                "subtitle": "",
                "payload": "",
                "actionDetail": {
                  "action": "TEXT"
                }
              }
            ]
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "66000002_8125",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66216478_1701165600000_SPRINKLR_LIVE_CHAT_313_6a22874219af3a65dbda4d28",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "68a36a9e97724224b7df5b75",
      "screenName": "UdyanTest"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_593683298"
  ],
  "errors": []
}
```

#### PRODUCT_LIST

**Example – Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66131825,
    "content": {
      "title": "product_list",
      "text": "checl",
      "attachment": {
        "type": "PRODUCT_LIST",
        "cardAttachmentList": [
          {
            "title": "product_list_image at top",
            "previewImageUrl": "https://example-4nemwiwh3a5t.com/resource/2",
            "type": "CARD"
          }
        ],
        "buttons": [
          {
            "title": "cta_UPDATE",
            "actionDetail": {
              "url": "https://www.sprinklr.com",
              "target": "_blank",
              "action": "OPEN_URL"
            }
          }
        ],
        "description": "message of image top",
        "disableManualResponse": true,
        "otherConfigs": {
          "layoutType": "IMAGE_TOP"
        },
        "screenReaderLabel": "reader"
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66127966_1770904503130_SPRINKLR_LIVE_CHAT_313_698ddbb7c720c33b56ab3438",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_3119636127"
  ],
  "errors": []
}
```

#### APPOINTMENT

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66001821,
    "content": {
      "title": "appointment",
      "text": "checl",
      "attachment": {
        "type": "APPOINTMENT",
        "selectDateTitle": "appointyment_date",
        "selectTimeTitle": "time_title",
        "selectDatePlaceholder": "placeholder",
        "submitDateTitle": "submit",
        "numDays": 2,
        "dateFormat": "MMM D YYYY",
        "submit": {
          "id": "29c20237-d0de-4bda-b021-e8d17f8f122a",
          "title": "Submit_button"
        },
        "postSubmit": {
          "id": "dba52a3f-865b-4dad-a80c-f8208301f585",
          "title": "Done"
        },
        "slotDefinitionConfigId": "68f755de6cb0171a504bb201",
        "showSubmittedContent": false,
        "disableManualResponse": true,
        "postSubmitTitle": "Thanks",
        "fromFirstAvailableSlot": false
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66127966_1770904503130_SPRINKLR_LIVE_CHAT_313_698ddbb7c720c33b56ab3438",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_3119636127"
  ],
  "errors": []
}
```

#### SURVEY

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66001821,
    "content": {
      "title": "Survey",
      "text": "Your feedback is important! Please share your valuable feedback.",
      "attachment": {
        "type": "SURVEY",
        "title": "Survey_title",
        "description": "desc_survey",
        "disableManualResponse": true,
        "postSubmitTitle": "Thanks",
        "screenReaderLabel": "screen_reader",
        "surveyButton": {
          "id": "85f7cfd8-4d01-454f-9092-e822c40f61ca",
          "title": "Open Survey_now"
        },
        "postSubmit": {
          "id": "2c611be3-4279-443b-bc80-4c84219195f3",
          "title": "Done"
        },
        "showSubmittedContent": true
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66127966_1770904503130_SPRINKLR_LIVE_CHAT_313_698ddbb7c720c33b56ab3438",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example – Response**

```bash
{
  "data": [
    "POST_3119636127"
  ],
  "errors": []
}
```

#### SECURE_FORM

**Example – Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66001821,
    "scheduleDate": 0,
    "content": {
      "attachment": {
        "type": "SECURE_FORM",
        "form": {
          "formTitle": "title_of_secure_form",
          "fields": [
            {
              "name": "Email_check_label",
              "type": "EMAIL"
            }
          ]
        },
        "submit": {
          "title": "Submit",
          "actionDetail": {
            "postBackHandlerType": "SECURE_FORM_POST_BACK",
            "action": "POST_BACK"
          }
        }
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "inReplyToMessageId": "ACCOUNT_66127966_1770904503130_SPRINKLR_LIVE_CHAT_313_698ddbb7c720c33b56ab3438",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_3119636127"
  ],
  "errors": []
}
```

#### RICH_TEXT_CAROUSEL

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66001821,
    "content": {
      "attachment": {
        "type": "RICH_TEXT_CAROUSEL",
        "disableManualResponse": true,
        "cardAttachmentList": [
          {
            "type": "CARD",
            "title": "CARD 1st Option",
            "previewImageUrl": "",
            "buttons": [
              {
                "id": "1234",
                "title": "Button 1",
                "subtitle": "",
                "payload": "",
                "actionDetail": {
                  "action": "TEXT"
                }
              }
            ]
          },
          {
            "type": "CARD",
            "title": "Card 2nd Option",
            "previewImageUrl": "",
            "buttons": [
              {
                "id": "8907",
                "title": "Button3",
                "subtitle": "",
                "payload": "",
                "actionDetail": {
                  "action": "TEXT"
                }
              }
            ]
          }
        ],
        "screenReaderLabel": "Rich_text"
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66127966_1770904503130_SPRINKLR_LIVE_CHAT_313_698ddbb7c720c33b56ab3438",
    "toProfile": {
      "channelType": "SPRINKLR_LIVE_CHAT",
      "channelId": "686ce4bdbfc4fe3077951a3c",
      "screenName": "Udyan_20.10"
    }
  }'
```

**Example - Response**

```bash
{
  "data": [
    "POST_3119636127"
  ],
  "errors": []
}
```

### 5.2 WhatsApp Dynamic Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists WhatsApp templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for "channelType": "WHATSAPP_BUSINESS".

For WhatsApp, you can use this API to publish the following message types:

- Publishing List Picker
- Publishing Card
- Publishing Card With Image
- Publishing Card With Video
- Publishing Card With Document
- Publishing Geolocation
- Publishing Request Location Message
- Publishing Address Message
- Publishing CTA URL


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

#### Request Parameters

Parameters
Sub Parameters
Sub-Param
Required/Optional
Description
Type
accountId
Required
The unique ID of the account added in the Sprinklr
Integer
content
Required
attachment
Required
Object containing attachment details.
Supported Types:
LIST_PICKER
CARD
GEO_LOCATION
REQUEST_LOCATION
ADDRESS
CTA_URL
For more details on the parameters of each attachment type, refer to the
Attachment Description Tables
below.
String
scheduleDate
Required
Schedule date for the message
Integer
taxonomy
Required
Object containing taxonomy details.
campaignId
Required
Campaign identifier to associate the message.
String
clientCustomProperties
Optional
client custom properties for the message
String
partnerCustomProperties
Optional
partner custom properties for the message
String
tags
Optional
Tags to be added to the message
String
urlShortenerId
Optional
URL shortener identifier to apply to the message
String
inReplyToMessageId
Required
The message ID on which the reply is being sent
String
approval
Optional
type
Optional
Type of approval to process. defaults to NONE
Supported Values
:
ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE
String
id
Optional
Value for the chosen approval type.
String
toProfile
Required
Object containing profile details.
Object
channelType
Required
Channel Type of the profile
String
channelId
Required
Channel Id of the profile
String
#### Attachment Object Parameters

Use the links below to navigate to the parameter tables for each attachment type.

- **LIST_PICKER**
- **CARD**
- **GEO_LOCATION**
- **REQUEST_LOCATION**
- **ADDRESS**
- **CTA_URL**


#### 5.2.1 LIST_PICKER Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this message template, use
LIST_PICKER.
String
header
Required
The object contains header test details
object
text
Required
The header text for list picker.
String
body
Required
The body text of list picker.
String
footerText
Required
The footer text of list picker.
String
buttonTitle
Required
The list picker button title.
String
sections
Required
The object containing the details of the list you want to send.
object
title
Required
The title of the list.
String
items
Required
The object contains the details of items
{
"id" : " ",
"title" : "",
"subtitle" : ""
}
String
#### 5.2.2 CARD Attachment Request Parameters

Parameters
Sub-Parameters
Required/Optional
Description
Type
type
Required
Type of attachment. For this message template, use
CARD.
String
header
Required
The object contains header details.
Object
document/image/text
Required
Refers to the card details based on the card type.
Refer to the
image/video/document Object Description Table
below for object details.
Object
footerText
Required
The footer text of card if any
String
buttons
Required
The array containing button details.
{
"id" : " ",
"title" : "",
"subtitle" : ""
}
Array
#### 5.2.3 Image, Video, and Document Object Request Parameters

Parameters
Required/Optional
Description
Type
type
Required
Refers to the type of card attachment.
Supported Values
:
IMAGE,
VIDEO,DOC
String
title
Optional
Refers to the title of the card attachment
String
url
Required for publishing Image and document cards
Refers to the url of the image/document that needs to be sent as attachment
String
#### 5.2.4 GEO_LOCATION Attachment Request Parameters

| **Parameter** | **Required/Optional** | **Description** | **Type** |
|  --- | --- | --- | --- |
| type | Required | Type of attachment. For this message template, use GEO_LOCATION. | String |
| latitude | Required | The latitude of the location. | Number |
| longitude | Required | The longitude of the location. | Number |
| name | Optional | The name of the location. | String |
| address | Optional | The complete address of the location. | String |


#### 5.2.5 REQUEST_LOCATION Attachment Request Parameters

This template allows you to create a Location request message that includes:

- A body text
- A send location button


When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location.

| **Parameter** | **Required/Optional** | **Description** | **Type** |
|  --- | --- | --- | --- |
| type | Required | Type of attachment. For this message template, use REQUEST_LOCATION. | String |
| message | Optional | Message text displayed when requesting location. | String |


#### 5.2.6 ADDRESS Attachment Request Parameters

This template allows you to publish an message that allows customers to share their address. The template contains a call-to-action (CTA) button that prompts the users to interact with the message, providing a convenient and streamlined way for them to share their shipping addresses.

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this message template, use
ADDRESS.
String
header
Optional
Header text for the attachment.
String
message
Optional
Main message body text.
String
footer
Optional
Footer text for the attachment.
String
addressFields
Optional
List of address field objects.
Array
fieldName
Required
Name of the address field.
Supported Values
:
CITY
String
prefilledValuePlaceHolder
Optional
Placeholder object for prefilled values.
Object
prefilledValuePlaceHolder.assetClass
Required
Asset class for the placeholder.
Supported Values
:
MESSAGE
String
prefilledValuePlaceHolder.customFieldName
Required
Custom field identifier
String
prefilledValuePlaceHolder.displayName
Required
Display name for the field
String
copyResponseToCustomField
Optional
Object used to map response to a custom field
Object
#### 5.2.7 CTA_URL Attachment Request Parameters

Your customers might hesitate to click on raw URLs that contain lengthy or obscure strings when they receive text messages. In such cases, you may prefer to send an interactive message with body text and a CTA URL button.

These CTA URL buttons enable you to link any URL to a button, eliminating the need to include the raw URL in the interactive message body.

Parameter
Sub-Parameter
Required/Optional
Description
Type
type
Required
Type of attachment. For this message template, use
CTA_URL.
String
header
Optional
Header section of the attachment
Object
header
image
Optional
Image object inside the header
Object
image.type
Required
Type of image.
Supported Values
:
IMAGE
String
image.url
Required
URL of the image resource
String
body
Optional
Main body text of the attachment
String
footerText
Optional
Footer text displayed in the attachment
String
ctaUrl
Required
URL that the CTA button points to
String
displayText
Required
Text displayed on the CTA button
String
urlType
Required
Type of URL.
Supported Values
:
STATIC
String
### Request Examples

The following examples show how to publish dynamic WhatsApp templates using the Publishing API.

- **LIST_PICKER**
- **CARD**
- **CARD with Image**
- **CARD with Video**
- **CARD with Document**
- **GEO_LOCATION**
- **REQUEST_LOCATION**
- **ADDRESS**
- **CTA_URL**


#### LIST_PICKER

**Example - Request**

```bash
 
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66074089,
    "content": {
      "attachment": {
        "type": "LIST_PICKER",
        "header": {
          "text": "header text"
        },
        "body": "list picker body",
        "footerText": "list picker footer text",
        "buttonTitle": "button title",
        "sections": [
          {
            "title": "section title 10",
            "items": [
              {
                "id": "ad4c0739-jdkskj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 10",
                "subtitle": "item subtitle 100"
              },
              {
                "id": "ad4c0739-jdsjnxzmj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 20",
                "subtitle": "item subtitle 200"
              }
            ]
          },
          {
            "title": "section title 20",
            "items": [
              {
                "id": "ad4c0739-jdkskjsnzm97-ef2-a055-c71e41c33da0",
                "title": "item title 210",
                "subtitle": "item subtitle 2100"
              },
              {
                "id": "ad4c0jnsxbjsazmj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 220",
                "subtitle": "item subtitle 2200"
              }
            ]
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66076311_1766498771000_WHATSAPP_BUSINESS_316_wamid.HBgMOTE3ODgwOTAxODMzFQIAEhgUM0FFOEVDOTFDNEE2NTg0M0IxMjEA",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "19283994232"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593683309"
  ],
  "errors": []
}
```

#### CARD

**Example - Request**

```bash
 
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 0,
    "content": {
      "attachment": {
        "type": "CARD",
        "header": {
          "text": "card header text"
        },
        "title": "card body",
        "footerText": "card footer text",
        "buttons": [
          {
            "id": "ad4c0739-jdkskjsnzm9dshxzjnm1c33da0",
            "title": "Sports",
            "subtitle": "Cricket"
          },
          {
            "id": "ad4c0739-sdhjzm9dshxzjnm1c33da0",
            "title": "Animals",
            "subtitle": "Tiger"
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "campaign-id",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_16848_1630938983000_WHATSAPP_BUSINESS_316_ABEGkZiGKVRZAhBU-gyq6wRu931SHImC9If4",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "channel-user-id-of-the-recipient"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_3329638977"
  ],
  "errors": []
}
```

#### CARD with Image

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66074089,
    "content": {
      "attachment": {
        "type": "LIST_PICKER",
        "header": {
          "image": {
            "type": "IMAGE",
            "url": "https://example-6f9da9a79fad.com/resource/1.jpg"
          }
        },
        "body": "list picker body",
        "footerText": "list picker footer text",
        "buttonTitle": "button title",
        "sections": [
          {
            "title": "section title 10",
            "items": [
              {
                "id": "ad4c0739-jdkskj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 10",
                "subtitle": "item subtitle 100"
              },
              {
                "id": "ad4c0739-jdsjnxzmj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 20",
                "subtitle": "item subtitle 200"
              }
            ]
          },
          {
            "title": "section title 20",
            "items": [
              {
                "id": "ad4c0739-jdkskjsnzm97-ef2-a055-c71e41c33da0",
                "title": "item title 210",
                "subtitle": "item subtitle 2100"
              },
              {
                "id": "ad4c0jnsxbjsazmj4c-4ef2-a055-c71e41c33da0",
                "title": "item title 220",
                "subtitle": "item subtitle 2200"
              }
            ]
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66076311_1766498771000_WHATSAPP_BUSINESS_316_wamid.HBgMOTE3ODgwOTAxODMzFQIAEhgUM0FFOEVDOTFDNEE2NTg0M0IxMjEA",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "19283994232"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593683390"
  ],
  "errors": []
}
```

#### CARD with Video

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 0,
    "content": {
      "attachment": {
        "type": "CARD",
        "header": {
          "video": {
            "type": "VIDEO",
            "url": "https://example-0e7ddb6e8899.com/resource/2.mp4"
          }
        },
        "title": "card body",
        "footerText": "card footer text",
        "buttons": [
          {
            "id": "ad4c0739-jdkskjsnzm9dshxzjnm1c33da0",
            "title": "Light 01",
            "subtitle": "Colourful"
          },
          {
            "id": "ad4c0739-sdhjzm9dshxzjnm1c33da0",
            "title": "Light 02",
            "subtitle": "Bright"
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "campaign-id",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_16848_1630938983000_WHATSAPP_BUSINESS_316_ABEGkZiGKVRZAhBU-gyq6wRu931SHImC9If4",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "channel-user-id-of-the-recipient"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_3329600771"
  ],
  "errors": []
}
```

#### CARD with Document

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 0,
    "content": {
      "attachment": {
        "type": "CARD",
        "header": {
          "document": {
            "type": "DOC",
            "title": "Test Document",
            "url": "https://example-f6f5efc0d6a8.com/resource/3.docx"
          }
        },
        "footerText": "card footer text",
        "buttons": [
          {
            "id": "ad4c0739-jdkskjsnzm9dshxzjnm1c33da0",
            "title": "Documents 01",
            "subtitle": "Layouts"
          },
          {
            "id": "ad4c0739-sdhjzm9dshxzjnm1c33da0",
            "title": "Documents 02",
            "subtitle": "Numbers"
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "campaign-id",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_16848_1630938983000_WHATSAPP_BUSINESS_316_ABEGkZiGKVRZAhBU-gyq6wRu931SHImC9If4",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "channel-user-id-of-the-recipient"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_3329056743"
  ],
  "errors": []
}
```

#### GEO_LOCATION

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66076311,
    "content": {
      "attachment": {
        "type": "GEO_LOCATION",
        "latitude": 21.2,
        "longitude": 22.0,
        "name": "Shivang Test",
        "address": "ggn, haryana"
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_2155",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "+918728071386"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_478638774"
  ],
  "errors": []
}
```

#### REQUEST_LOCATION

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66074089,
    "content": {
      "attachment": {
        "type": "REQUEST_LOCATION",
        "message": "Testing message of location"
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "inReplyToMessageId": "ACCOUNT_66076311_1766498771000_WHATSAPP_BUSINESS_316_wamid.HBgMOTE3ODgwOTAxODMzFQIAEhgUM0FFOEVDOTFDNEE2NTg0M0IxMjEA",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "19283994232"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_545622579"
  ],
  "errors": []
}
```

#### ADDRESS

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 12345678987,
    "content": {
      "attachment": {
        "type": "ADDRESS",
        "header": "Address head",
        "message": "Address is valid\n",
        "footer": "end",
        "addressFields": [
          {
            "fieldName": "CITY",
            "prefilledValuePlaceHolder": {
              "assetClass": "MESSAGE",
              "customFieldName": "_c_64fae608cf9529693818a170",
              "displayName": "BMK Text"
            },
            "copyResponseToCustomField": {}
          }
        ]
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "inReplyToMessageId": "ACCOUNT_66076311_1766498771000_WHATSAPP_BUSINESS_316_wamid.HBgMOTE3ODgwOTAxODMzFQIAEhgUM0FFOEVDOTFDNEE2NTg0M0IxMjEA",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "19283994232"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_545623756"
  ],
  "errors": []
}
```

#### CTA_URL Button

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66074089,
    "content": {
      "attachment": {
        "type": "CTA_URL",
        "header": {
          "image": {
            "type": "IMAGE",
            "url": "https://example-vuocn8lnzd6o.com/resource/5"
          }
        },
        "body": "Tap the button below to know more",
        "footerText": "Know More",
        "ctaUrl": "https://www.sprinklr.com",
        "displayText": "Buy",
        "urlType": "STATIC"
      }
    },
    "scheduleDate": 0,
    "taxonomy": {
      "campaignId": "66000002_5947",
      "clientCustomProperties": {},
      "partnerCustomProperties": {}
    },
    "inReplyToMessageId": "ACCOUNT_66076311_1766498771000_WHATSAPP_BUSINESS_316_wamid.HBgMOTE3ODgwOTAxODMzFQIAEhgUM0FFOEVDOTFDNEE2NTg0M0IxMjEA",
    "toProfile": {
      "channelType": "WHATSAPP_BUSINESS",
      "channelId": "19283994232"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_545624040"
  ],
  "errors": []
}
```

### 5.3 Instagram Dynamic Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists Instagram templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for&nbsp;"channelType": "INSTAGRAM".

For Instagram, you can use this API to publish the following message types:

- **Publishing Quick Replies**
- **Publishing Carousel**


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

#### Request Parameters

The API request payload remains the same except for the `attachment` object, which differs for Quick Replies and Carousel.

Parameters
Sub Parameters
Required/Optional
Description
Type
accountId
Required
The account ID to schedule/sent message.
Integer
content
Required
The object containing content details.
Object
attachment
Required
The attachment object contains the details of the attachment for QUICK_REPLY and CAROUSEL. For more details, check Attachment Description Table below.
String
scheduleDate
Optional
The schedule date for the message.
Integer
taxonomy
Required
The object containing taxonomy details.
Object
campaignId
Required
The unique campaign identifier to associate the message.
String
clientCustomProperties
Optional
The client custom properties for the message.
String
partnerCustomProperties
Optional
The partner custom properties for the message.
String
tags
Optional
Tags to be added to the message.
String
urlShortenerId
Optional
The URL shortener identifier to apply to the message.
String
inReplyToMessageId
Required
The message ID on which the reply is being sent.
String
approval
Optional
The object containing approval details.
Object
type
Optional
Type of approval to process. Defaults to `NONE`
Enum:
[
ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE ].
String
id
Optional
Value for the chosen approval type.
String
toProfile
Required
The object containing profile details of the user to whom you are replying.
Object
channelType
Required
Channel Type of the profile.
String
channelId
Required
Channel ID of the profile.
String
screenName
Required
Name of the profile.
String
#### 5.3.1 QUICK_REPLY Attachment Request Parameters

Parameter
Sub Parameter
Required/Optional
Description
Type
message
Required
The message to display above quick reply.
String
type
Required
The type of attachment i.e. QUICK_REPLY.
String
quickReplies
Required
An array of objects.
Array
title
Required
Text to display within quick reply.
String
actionDetails
Required
The object containing click action details.
"actionDetail": {
"action": "TEXT"
}
object
#### 5.3.2 CAROUSEL Attachment Request Parameters

Parameter
Sub-Parameter
Required/Optional
Description
Type
Type
Required
The type of attachment i.e. CAROUSEL.
String
CardAttachmentList
Required
The list of images/cards in a carousel.
Array
Type
Required
The type of attachment.
String
Title
Required
The title of the attachment.
String
Description
Required
The description of the attachment.
String
previewImageUrl
Required
The URL of the attachment.
String
Buttons
Required
An array of buttons to append to the carousel.
Array
#### 5.3.3 Button Array Parameters

Parameter
Required/Optional
Description
Type
Title
Required
Title of the button.
String
ActionDetail
Required
In case of CAROUSEL post, the possible action is:

"actionDetail": {
  "action": "TEXT",
  "Data": "TEXT_POST_BACK"
}

Object
### Request Examples

#### QUICK_REPLY

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66129671,
    "content": {
      "attachment": {
        "message": "Quick reply text",
        "type": "QUICK_REPLY",
        "quickReplies": [
          {
            "title": "quick reply title 1",
            "actionDetail": {
              "action": "TEXT"
            }
          },
          {
            "title": "quick reply title 2",
            "actionDetail": {
              "action": "TEXT"
            }
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "66000002_2"
    },
    "allowDuplicateMessages": true,
    "inReplyToMessageId": "ACCOUNT_66129671_1507189817000_INSTAGRAM_36_1618747972892042010_2182294329",
    "toProfile": {
      "channelType": "INSTAGRAM",
      "channelId": "<CUSTOMER_INSTAGRAM_ID>"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593684786"
  ],
  "errors": []
}
```

#### CAROUSEL

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 1171002,
    "content": {
      "attachment": {
        "type": "CAROUSEL",
        "cardAttachmentList": [
          {
            "type": "CARD",
            "title": "CARD 1",
            "description": "CARD description",
            "previewImageUrl": "https://qa4-cdata-secure.sprinklr.com/DAM/400002/2ab9bde4-781c-4d4b-ae75-733bdad77daf-1032962294/GULFSTREAM-450-EXTERIOR-FINAL-_p.jpg",
            "buttons": [
              {
                "title": "button 1",
                "actionDetail": {
                  "action": "TEXT",
                  "data": "TEXT_POST_BACK"
                }
              }
            ],
            "defaultButton": {
              "actionDetail": {
                "url": "http://www.google.com",
                "action": "OPEN_URL"
              }
            }
          },
          {
            "type": "CARD",
            "title": "CARD 2",
            "description": "CARD description 2",
            "previewImageUrl": "https://qa4-sprcdn-assets.sprinklr.com/400002/c536c5dd-9ddc-47e4-8916-05b291637ec8-637631488.jpg",
            "buttons": [
              {
                "title": "button 1",
                "actionDetail": {
                  "action": "TEXT",
                  "data": "TEXT_POST_BACK"
                }
              }
            ],
            "defaultButton": {
              "actionDetail": {
                "url": "http://www.google.com",
                "action": "OPEN_URL"
              }
            }
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "4706_750"
    },
    "allowDuplicateMessages": true,
    "inReplyToMessageId": "ACCOUNT_1171002_1644480334000_INSTAGRAM_320_aWdfZAG1faXRlbToxOklHTWVzc2FnZA2Njg0MTcxMDMwMDk0OTEyODI0NTg0Mzg1OTc1MTk5MUlEOjE3ODQxNDUwODEwMzAzMTcyOjM0MDI4MjMjozMDMzNTMwNzg2MzIyMDQxNTYxNTgyOTc1NjYwMjIyMDU0NAZDZD",
    "toProfile": {
      "screenName": "XYZ",
      "channelType": "INSTAGRAM",
      "channelId": "5116428976785642"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_6311898541"
  ],
  "errors": []
}
```

### 5.4 Facebook Dynamic Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists Facebook templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for&nbsp;"channelType": "FACEBOOK".

For Facebook, you can use this API to publish the following message types:

- Publishing Quick Reply
- Publishing Question with Answers (Button Template)
- Publishing Multiple Products (Carousel)


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

### Request Parameters

Parameters
Sub Parameters
Sub-Param
Required/Optional
Description
Type
accountId
Required
Array of account IDs to schedule message to
Integer
content
Required
title
Optional
Title of the message.
String
text
Optional
Text of the message.
String
attachment
Required
Type of attachment with respect to the template type.
Kindly find the attachment object descriptions below for the respective template type.
Object
taxonomy
Required
Object containing taxonomy details.
campaignId
Required
Campaign identifier to associate the message.
String
clientCustomProperties
Optional
client custom properties for the message
String
partnerCustomProperties
Optional
partner custom properties for the message
String
tags
Optional
Tags to be added to the message
String
urlShortenerId
Optional
URL shortener identifier to apply to the message
String
inReplyToMessageId
Required
The message ID on which the reply is being sent
String
scheduleDate
Optional
Schedule date for the message
Epoch (Milliseconds)
approval
Optional
type
Optional
Type of approval to process. defaults to `NONE`
Enum:
[
ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE ]
String
id
Optional
Value for the chosen approval type.
String
toProfile
Required
Current version of the message.
Integer
channelType
Required
Channel Type of the profile
String
channelId
Required
Channel ID of the profile
String
screenName
Required
Screen name of the profile
String
### Attachment Object Parameters

Use the sections below to review the parameters for each attachment type.

- **QUICK_REPLY**
- **BUTTON_TEMPLATE**
- **CAROUSEL**


#### 5.4.1 QUICK_REPLY Attachment Request Parameters

Parameters
Sub Parameters
Required/Optional
Description
Type
type
Required
QUICK_REPLY
String
message
Optional
Refers to the message you want to send in the template
String
quickReplies
Required
Array containing the quick reply details
Array
title
Required
Refers to the title of the button
String
subtitle
Optional
Refers to the subtitle of button.
String
imageUrl
Optional
Refers to the image URL you want to send along with quick reply
Url
actionDetail
Required
In case of QUICK_REPLY the possible action is:
"actionDetail" : { "action" : "TEXT" }
Object
#### 5.4.2 BUTTON_TEMPLATE Attachment Request Parameters

Parameters
Sub Parameters
Sub-Param
Required/Optional
Description
Type
type
Required
BUTTON_TEMPLATE
String
elementList
Required
Array containing the list of items in the button template
Array
title
Required
Refers to the question you want to ask
string
elementList
Required
Array containing the buttons for the respective answers
Array
title
Required
Refers to the text for the first answer
String
url
Optional
Required when actionType is “web_url”
Refers to the URL the answer would redirect to when the button is clicked
String
actionType
Required
Refers to the action type that should be performed when the user clicks on the button
Supported actionType:
web_url
no_action
String
type
Optional
Refers to the type of answer format
Example: text
String
#### 5.4.3 CAROUSEL Attachment Request Parameters

Parameters
Sub Parameters
Required/Optional
Description
Type
type
Required
CAROUSEL
String
cardAttachmentList
Required
The list containing details for all the items in the carousel
Array
type
Required
Refers to the type of attachment, i.e., CARD in this case
String
title
Required
Refers to the title of the item in the carousel
String
description
Required
Refers to the description of the item in the carousel
String
previewImageUrl
Required
The image URL of the item in the carousel
String
buttons
Required
An array of buttons to append to the carousel.
Refer to the table below for button array parameters' description
Array
#### 5.4.4 Button Array Parameters

Parameters
Sub-Parameter
Required/Optional
Description
Type
title
Required
Refers to the title of button
String
actionDetail
Required
Object containing the action details that need to be performed once the user clicks on the button
Object
action
Required
Refers to the action that will be performed once the user clicks on the button
Possible actions for carousel post include: OPEN_URL, POST_BACK
String
url
Optional
Required if the action type is OPEN_URL
Refers to the URL the user needs to be redirected to when they click on the button
String
data
Optional
Required if the action type is TEXT
Refers to the text you want to display once the user clicks on the button
String
### Request Examples

The following examples show how to publish dynamic Facebook templates using the Publishing API.

- **QUICK_REPLY**
- **BUTTON_TEMPLATE**
- **CAROUSEL**


#### QUICK_REPLY

**Example - Request**

```bash
      
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66085334,
    "content": {
      "text": "FB replying 01",
      "attachment": {
        "type": "QUICK_REPLY",
        "message": "Sports",
        "quickReplies": [
          {
            "title": "Cricket",
            "subtitle": "Flower",
            "imageUrl": "https://example-6xnylwmmwzff.com/resource/1",
            "actionDetail": {
              "action": "TEXT"
            }
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "inReplyToMessageId": "ACCOUNT_66085334_1786437461000_FACEBOOK_14_1215182290622248_2030445457834952",
    "toProfile": {
      "channelType": "FACEBOOK",
      "channelId": "2964116967457583",
      "screenName": "Sanity Test"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593685584"
  ],
  "errors": []
}
```

#### BUTTON_TEMPLATE

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_473209_1683975928000_FACEBOOK_39_m_XQcYwfJFL8R_VUczEimxzAIyztlWnuT6EVnspd1zZpQY5n3NZfYAbTygkoJvbpmdmfZF2QNDEvdnjaP8zvTq3g",
    "accountId": 473209,
    "content": {
      "attachment": {
        "type": "BUTTON_TEMPLATE",
        "elementList": [
          {
            "title": "What is your Favorite Channel?",
            "elementList": [
              {
                "title": "Option 1",
                "url": "https://www.google.com",
                "actionType": "web_url",
                "type": "text"
              },
              {
                "title": "Option 2",
                "url": "https://www.google.com",
                "actionType": "web_url",
                "type": "text"
              },
              {
                "title": "Option 3",
                "url": "https://www.google.com",
                "actionType": "web_url",
                "type": "text"
              }
            ]
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "4706_11345"
    },
    "toProfile": {
      "channelType": "FACEBOOK",
      "channelId": "3625508374175097"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000006300139"
  ],
  "errors": []
}
```

#### CAROUSEL

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_1000123885_1683042814000_FACEBOOK_38_m_6wh1YCmZChg7C58skWbr-gP4HMIYYTGsbnEOZ3GiiASY9x_y8BsTDgw03hUgVbU1FYHq0BAf3HazF5GkbAjqPQ",
    "accountId": 1000123885,
    "content": {
      "attachment": {
        "type": "CAROUSEL",
        "cardAttachmentList": [
          {
            "type": "CARD",
            "title": "CARD 1",
            "description": "CARD description",
            "previewImageUrl": "https://example-693d591c2450.com/resource/4.jpg",
            "buttons": [
              {
                "title": "button 1",
                "actionDetail": {
                  "action": "OPEN_URL",
                  "url": "http://www.google.com"
                }
              }
            ]
          },
          {
            "type": "CARD",
            "title": "CARD 2",
            "description": "CARD description 2",
            "previewImageUrl": "https://example-4dd69193848f.com/resource/5.jpg",
            "buttons": [
              {
                "title": "button 1",
                "actionDetail": {
                  "url": "http://www.google.com",
                  "action": "OPEN_URL"
                }
              }
            ]
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "1000004509_1653"
    },
    "toProfile": {
      "channelType": "FACEBOOK",
      "channelId": "5803051299812515",
      "screenName": "Test User"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000006300140"
  ],
  "errors": []
}
```

### 5.5 Twitter Dynamic Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists Twitter templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for&nbsp;"channelType": "TWITTER".

For Twitter, you can use this API to publish the following message type:

- Publishing Quick Reply


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

#### Request Parameters

Parameters
Sub Parameters
Sub-Param
Required/Optional
Description
Type
accountId
Required
Array of account IDs to schedule message to
Integer
content
Required
title
Optional
Title of the message.
String
text
Optional
Text of the message.
String
attachment
Required
Type of attachment
String
type
Required
QUICK_REPLY, by default.
String
title
Required
Title of the card.
String
previewImageUrl
Required
Preview image URL.
String
disableManualResponse
Required
false, by default.
Boolean
buttons
[ {
"id" : "",
"title" : "",
"subtitle" : "",
"payload" : "",
"actionDetail" : {
"action" : ""
}
} ]
Required
Check the Button Description Table below.
String,
Integer
scheduleDate
Required
Schedule date for the message
Integer
taxonomy
Required
Object containing taxonomy details.
campaignId
Required
Campaign identifier to associate the message.
String
clientCustomProperties
Optional
client custom properties for the message
String
partnerCustomProperties
Optional
partner custom properties for the message
String
tags
Optional
Tags to be added to the message
String
urlShortenerId
Optional
URL shortener identifier to apply to the message
String
inReplyToMessageId
Required
The message ID on which the reply is being sent
String
approval
Optional
type
Optional
Type of approval to process. defaults to NONE
Enum:
[
ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE ]
String
id
Optional
Value for the chosen approval type.
String
toProfile
Required
Current version of the message.
Integer
channelType
Required
Channel Type of the profile
String
channelId
Required
Channel ID of the profile
String
screenName
Required
Screen name of the profile
String
#### Attachment Object Parameters

Use the section below to review the parameters for the supported attachment type.

#### QUICK_REPLY Attachment Request Parameters

Parameter
Required/Optional
Description
Type
Id
Required
Any unique ID.
String
title
Required
Title of button.
String
subtitle
Optional
Subtitle of button.
String
payload
Optional
Payload of button. Not supported in Facebook and Twitter
String
actionDetail
Required
In case of QUICK_REPLY the possible action is:
"actionDetail" : { "action" : "TEXT" }
String
#### Request Examples

The following example shows how to publish a dynamic Twitter Quick Reply template using the Publishing API.

- **QUICK_REPLY**


#### 5.5.1 QUICK_REPLY

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 66138407,
    "content": {
      "text": "again template check",
      "attachment": {
        "type": "QUICK_REPLY",
        "message": "Question 16",
        "quickReplies": [
          {
            "title": "Option 16",
            "subtitle": "Flower",
            "imageUrl": "https://example-94452ef5f590.com/resource/6.jpg",
            "actionDetail": {
              "action": "TEXT"
            }
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "inReplyToMessageId": "ACCOUNT_66138407_1786438079589_TWITTER_4_2086907846885540241",
    "toProfile": {
      "channelType": "TWITTER",
      "channelId": "2558998452",
      "screenName": "ITest"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593685674"
  ],
  "errors": []
}
```

### 5.6 Apple Business Chat Templates

You can use this API to publish dynamic templates across supported social and messaging channels. This page specifically lists Apple Business Chat templates that you can publish using the API. Each template type includes its own parameters and example payloads to help you construct and test your requests.

**Dev Notes:** This API enhancement strictly works for&nbsp;"channelType": "APPLE_BUSINESS_CHAT".

For Apple Business Chat, you can use this API to publish the following message types:

- Publishing Rich Link
- Publishing List Picker
- Publishing Text/Link
- Publishing Authentication
- Publishing Quick Reply
- Publishing Time Picker
- Publishing iMessage
- Publishing Apple Pay
- Publishing Form


**API Endpoint**

https://api3.sprinklr.com/{env}/api/v3/publishing/message

### Request Parameters

Parameters
Sub Parameters
Sub-Param
Required/Optional
Description
Type
accountId
Required
Array of account IDs to schedule message to
Integer
content
Required
attachment
Required
The attachment object contains the details of the attachment for LIST PICKER and CARD. For more details, check Attachment Description Table below.
String
scheduleDate
Required
Schedule date for the message
Integer
taxonomy
Required
Object containing taxonomy details.
campaignId
Required
Campaign identifier to associate the message.
String
clientCustomProperties
Optional
client custom properties for the message
String
partnerCustomProperties
Optional
partner custom properties for the message
String
tags
Optional
Tags to be added to the message
String
urlShortenerId
Optional
URL shortener identifier to apply to the message
String
inReplyToMessageId
Required
The message ID on which the reply is being sent
String
approval
Optional
type
Optional
Type of approval to process. defaults to `NONE`
Enum:
[
ACCOUNT_OWNER, USER, APPROVAL_PATH, NONE ]
String
id
Optional
Value for the chosen approval type.
String
toProfile
Required
Current version of the message.
Integer
channelType
Required
Channel Type of the profile
String
channelId
Required
Channel ID of the profile
String
screenName
Optional
The user's screen name on the channel
String
### Attachment Object Parameters

Use the sections below to review the parameters for each attachment type.

- **RICH_LINK**
- **LIST_PICKER**
- **TEXT/LINK**
- **AUTHENTICATION**
- **QUICK_REPLY**
- **TIME_PICKER**
- **iMESSAGE**
- **APPLE_PAY**
- **FORM**


#### 5.6.1 RICH_LINK Attachment Request Parameters

Parameter
Required/Optional
Description
Type
link
Optional
Refers to the link where the user will be redirected
Url
title
Optional
Refers to the title of the template
String
mediaUrl
Required
Refers to the media URL
Url
previewUrl
Optional
Refers to the preview media URL
String
type
Required
Refers to the type of link.
Default:
RICH_LINK
String
#### 5.6.2 LIST_PICKER Attachment Request Parameters

Parameter
Sub Parameter
Required/Optional
Description
Type
multipleSelection
Required
If true, multiple selections will be permissible for the attachment
Boolean
sections
Required
Refers to the array defining section details
Array
title
Required
Refers to the title of the section
String
multipleSelection
Required
If true, multiple selections will be permissible for the section
Boolean
items
Required
Array containing the item details in the section
Refer to the table below for Items array description
Array
receivedMessage
Required
Object containing the received message details
Object
title
Optional
Refers to the title of the received message
String
style
Optional
Refers to the style of the message.
Supported Values: icon, small, large
String
imageUrl
Optional
Refers to the image URL of the received message
Url
replyMessage
Required
Object containing the reply message details
Object
title
Optional
Refers to the title of the reply message
String
style
Optional
Refers to the style of the message.
Supported Values: icon, small, large
String
imageUrl
Optional
Refers to the image URL of the reply message
Url
### Items Array Parameters

Parameter
Required/Optional
Description
Type
title
Optional
Refers to the title of the item
String
style
Optional
Refers to the style of the item
Supported Values: icon, small, large
String
imageUrl
Optional
Refers to the image URL of the item
Url
#### 5.6.3 TEXT/LINK Request Parameters

| **Parameter** | **Required/Optional** | **Description** | **Type** |
|  --- | --- | --- | --- |
| text | Required | Refers to the text or the link of the message | String |


#### 5.6.4 AUTHENTICATION Attachment Request Parameters

| **Parameter** | **Sub Parameter** | **Required/Optional** | **Description** | **Type** |
|  --- | --- | --- | --- | --- |
| type |  | Required | Refers to the type of the template | String |
|  |  | Optional | Refers to the unique identifier for the social login app | String |
| additionalParameters |  | Optional | Object defining additional parameters (if any) | Object |
| scope |  | Optional | Refers to the list defining the scope of the authentication | List [String] |
| receivedMessage |  | Optional | Object defining the received message details | Object |
|  | title | Optional | Refers to the tile of the received message | String |
|  | subTitle | Optional | Refers to the sub title of the received message | String |
|  | secondarySubtitle | Optional | Refers to the secondary sub title of the received message | String |
|  | tertiarySubtitle | Optional | Refers to the tertiary sub title of the received message | String |
|  | imageUrl | Optional | Refers to the url of the image attachment | Url |
| replyMessage |  | Optional | Object defining the reply message details | Object |
|  | title | Optional | Refers to the title of the reply message | String |
|  | subTitle | Optional | Refers to the sub title of the reply message | String |
|  | secondarySubtitle | Optional | Refers to the secondary sub title of the reply message | String |
|  | tertiarySubtitle | Optional | Refers to the tertiary sub title of the reply message | String |
|  | imageurl | Optional | Refers to the url of the image attachment | Url |


#### 5.6.5 QUICK_REPLY Attachment Request Parameters

Parameter
Sub Parameter
Required/Optional
Description
Type
type
Required
Refers to the template type
String
message
Required
Refers to the message of the template
String
quickReplies
Refers to the array defining the quick reply details.
You can add two to five customizable choices and the user can select only one from the list
Required
Array
id
Optional
Refers to the unique identifier for the quick reply
String
title
Required
Refers to the title of the quick reply
String
actionDetail
Required
Object defining the action details:
{
"action": "TEXT"
}
Object
#### 5.6.6 TIME_PICKER Attachment Request Parameters

Parameter
Sub-Parameters
Required/Optional
Description
Type
receivedMessage
Optional
Object defining the received message details
Object
title
Optional
Refers to the title of the message
String
subTitle
Optional
Refers to the sub title of the message
String
secondarySubtitle
Optional
Refers to the secondary title of the message
String
tertiarySubtitle
Optional
Refers to the tertiary title of the message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageUrl
Optional
Refers to the url of the image
Url
replyMessage
Required
Object defining the reply message details
Object
title
Optional
Refers to the title of the message
String
subtitle
Optional
Refers to the sub title of the message
String
secondarySubtitle
Optional
Refers to the secondary title of the message
String
tertiarySubtitle
Optional
Refers to the tertiary title of the message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageurl
Optional
Refers to the url of the image
Url
location
Optional
Object defining the location details
Object
latitude
Optional
Refers to the latitude configuration
number
longitude
Optional
Refers to the longitude configuration
number
radius
Optional
Refers to the radius configuration
number
title
Optional
Refers to the location title
String
timeSlots
Optional
Array defining the time slot details
Array
startTime
Optional
Refers to the start time of the event
Integer
duration
Optional
Refers to the duration of the event
Integer
timezone
Optional
Refers to the time zone of the event
String
title
Optional
Refers to the title of the event
String
type
Required
Refers to the type of the event
#### 5.6.7 iMESSAGE Attachment Request Parameters

Parameter
Sub-Parameters
Required/Optional
Description
Type
type
Required
String
appId
Optional
Refers to the application ID
String
appName
Optional
Refers to the app name
String
bId
Optional
String
url
Optional
Refers to the base URL of the iMessage
Url
useLiveLayout
Optional
If yes, the template shows the live app layout in the message
Boolean
attachments
Required
Refers to the array of attachments associated with the message
Array
type
Required
Refers to the type of attachment
String
url
Required
Refers to the url of the attachment
Url
title
Optional
Refers to the title of the attachment
String
description
Optional
Refers to the description of the attachment
String
receivedMessage
Optional
Object containing the received message details
Object
title
Optional
Refers to the title of the received message
String
subTitle
Optional
Refers to the sub title of the received message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageUrl
Optional
Refers to the url of the image
Url
replyMessage
Optional
Object containing the reply message details
Object
title
Optional
Refers to the title of the reply message
String
subTitle
Optional
Refers to the sub title of the reply message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageurl
Optional
Refers to the url of the image
Url
#### 5.6.8 APPLE_PAY Attachment Request Parameters

Parameter
Sub-Parameters
Required/Optional
Description
Type
receivedMessage
Optional
Object defining the received message details
Object
imageUrl
Optional
Refers to the image URL of the received message
Url
title
Optional
Refers to the title of the received message
String
replyMessage
Optional
Object defining the reply message details
Object
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
title
Optional
Refers to the title of the reply message
String
paymentRequest
Required
Object defining the payment request details
Object
lineItems
Optional
Array defining the line item details
Array
total
Optional
Object defining the total details
Object
countryCode
Optional
Refers to the country code
String
currencyCode
Optional
Refers to the currency code
String
requiredBillingContactFields
Optional
List defining the billing contact details
List [String]
requiredShippingContactFields
Optional
List defining the shipping contact details
List [String]
supportedCountries
Optional
List defining the supported country details
List [String]
shippingMethods
Optional
Array defining the shipping method details
Array
applePay
Optional
Object defining apple pay details
Object
type
Required
Refers to the template type
String
paymentAccountId
Optional
Refers to the account ID to which the payment needs to be sent
#### 5.6.9 FORM Attachment Request Parameters

Parameter
Sub-Parameters
Required/Optional
Description
Type
messageTitle
Optional
Refers to the title of the message
String
messageSubtitle
Optional
Refers to the subtitle of the message
String
buttonTitle
Optional
Refers to the title of the button
String
form
Required
Refers to the object containing the form details
Object
formTitle
Optional
Refers to the title of the form
String
repeatable
Optional
If true, the form is repeatable
Boolean
minCount
Optional
Refers to the minimum count of the form
Integer
maxCount
Optional
Refers to the maximum count of the form
Integer
fields
Optional
Refers to the array defining the form fields.
Refer to the table below for the array details
Array
submit
Required
Object Defining the submit button details
Object
title
Optional
Refers to the title of the submit button
String
showSummary
Optional
If true, the summary of the message is form responses in shown
Boolean
receivedMessage
Optional
Object defining the received message details
Object
title
Optional
Refers to the title of the message
String
subTitle
Optional
Refers to the subtitle of the message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageUrl
Optional
Refers to the url of the image
Url
replyMessage
Optional
Object defining the reply message details
Object
title
Optional
Refers to the title of the reply message
String
subTitle
Optional
Refers to the sub title of the reply message
String
style
Optional
Refers to the style of the message
Supported values:
Icon (40 X 40)
Small (60 X 60)
Large (263 X150)
String
imageUrl
Optional
Refers to the url of the image
Url
type
Required
Refers to the type of template
string
### Fields Array Parameters

Parameter
Sub-Parameters
Required/Optional
Description
Type
name
Optional
Refers to the name of the field
String
description
Optional
Refers to the description of the field
String
type
Refers to the type of the template
Supported Values:
Form,
Date Picker,
Picker,
Select
String
picklistValues
Optional
Refers to the array defining the picklist details
Array
label
Optional
Refers to the label of the picklist value
String
value
Optional
Refers to the value of the picklist
String
parentChild
Optional
If true, the field has a parent child hierarchy
Boolean
multiValued
Optional
If true, the fields support multiple values
Boolean
defaultValue
Optional
Refers ton the default value of the field (if any)
String
additional
Optional
Object containing additional details if any
Object
maximumDate
Optional
The date till when the field will be available
String
minimumDate
Optional
The starting time from when the field will be available
String
dateFormat
Optional
The format of the date
String
### Request Examples

The following examples show how to publish dynamic Apple Business Chat templates using the Publishing API.

- **RICH_LINK**
- **LIST_PICKER**
- **TEXT/LINK**
- **AUTHENTICATION**
- **QUICK_REPLY**
- **TIME_PICKER**
- **iMESSAGE**
- **APPLE_PAY**
- **FORM**


#### RICH_LINK

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_66002125_1785401373424_APPLE_BUSINESS_CHAT_317_a2bc85e0-2201-430a-b342-242fa33400e7",
    "accountId": 66002125,
    "content": {
      "attachment": {
        "link": "https://www.google.com",
        "title": "asdas",
        "mediaUrl": "https://example-0rwk5qg414ym.com/resource/4",
        "previewUrl": "https://example-0rwk5qg414ym.com/resource/4",
        "type": "RICH_LINK"
      }
    },
    "taxonomy": {
      "campaignId": "66000002_5947"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY0pFKmydIKHoBRKdEkPYaLSYiapi383MLy31aPF/hWxcO8ioZL5iHrFUMKfSy9x1mt0/BvFYj9KeAz2nfK5EB5XuXhUgu314KtjNZZ4YNoDfyNjsvBdMyB0sEzAvwZ1dJfjWjttdpsHCB8WfD/RAHbgtPLg=",
      "screenName": "Apple User 24"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_593685779"
  ],
  "errors": []
}
```

#### LIST_PICKER

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_600001079_1619085773531_APPLE_BUSINESS_CHAT_317_41b4222d-011b-41aa-a489-f00c6528249c",
    "accountId": 600001079,
    "content": {
      "text": "List picker new msg",
      "attachment": {
        "multipleSelection": false,
        "sections": [
          {
            "title": "as",
            "multipleSelection": true,
            "items": [
              {
                "title": "asd",
                "style": "small",
                "imageUrl": "https://example-bc59f53fa44e.com/resource/7.gif"
              }
            ]
          }
        ],
        "receivedMessage": {
          "title": "asd",
          "style": "small",
          "imageUrl": "https://example-325dd5407ed6.com/resource/8.gif"
        },
        "replyMessage": {
          "title": "asd",
          "imageUrl": "https://example-f48f096b384c.com/resource/9.gif",
          "style": "icon"
        },
        "type": "LIST_PICKER"
      }
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY3RBepJ6tIWXKLmZBmqUKb6ZYfAdFGI3AEtusg5jrUSYksuK3QeD/MfYLjHDXvv01gfVZDoUKXCObgRsb0HeLHuQz+CiKI4yk/GoAWIPEbJHtJX1Qs/inhySc/XklecIWi4qfcjAyWgzaGtZyaPIJXPxm0Y=",
      "screenName": "Apple User 24"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_3329638977"
  ],
  "errors": []
}
```

#### TEXT/LINK

**Example - Request**

```bash

curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_600001079_1619085773531_APPLE_BUSINESS_CHAT_317_41b4222d-011b-41aa-a489-f00c6528249c",
    "accountId": 600001079,
    "content": {
      "text": "https://www.youtube.com/"
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY3RBepJ6tIWXKLmZBmqUKb6ZYfAdFGI3AEtusg5jrUSYksuK3QeD/MfYLjHDXvv01gfVZDoUKXCObgRsb0HeLHuQz+CiKI4yk/GoAWIPEbJHtJX1Qs/inhySc/XklecIWi4qfcjAyWgzaGtZyaPIJXPxm0Y=",
      "screenName": "Apple User 24"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_3329608771"
  ],
  "errors": []
}
```

#### AUTHENTICATION

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_600028667_1675417733748_APPLE_BUSINESS_CHAT_317_c23d7936-2f15-4eb5-ab30-d5a09bb2077b",
    "accountId": 600028667,
    "content": {
      "attachment": {
        "type": "AUTHENTICATION",
        "loginAppConfigId": "62ff0c3c5a2bf53a1bcf1bca",
        "additionalParameters": {},
        "scope": [
          "scope1"
        ],
        "receivedMessage": {
          "title": "title of Auth Temp",
          "subtitle": "msg subtite",
          "secondarySubtitle": "sec subtitle Auth Temp ",
          "tertiarySubtitle": "ter subtitle msg",
          "imageUrl": "https://example-5d8e22ff2646.com/resource/10.jpg"
        },
        "replyMessage": {
          "title": "title val Auth Temp",
          "subtitle": "subtitle",
          "secondarySubtitle": "sec subtitle",
          "tertiarySubtitle": "ter subtitle",
          "imageUrl": "https://example-65b3e0cfbcc1.com/resource/11.jpg"
        }
      }
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019355335"
  ],
  "errors": []
}
```

#### QUICK_REPLY

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 600028667,
    "content": {
      "text": "Quick Reply Test3",
      "attachment": {
        "type": "QUICK_REPLY",
        "message": "Question 1",
        "quickReplies": [
          {
            "id": "123",
            "title": "Option 1",
            "actionDetail": {
              "action": "TEXT"
            }
          }
        ]
      }
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "inReplyToMessageId": "ACCOUNT_600028667_1675850276305_APPLE_BUSINESS_CHAT_317_1693d544-c3a0-456f-b42c-54f46f5bbee5",
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019355337"
  ],
  "errors": []
}
```

#### TIME_PICKER

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 600028667,
    "content": {
      "text": "Time Picker",
      "attachment": {
        "receivedMessage": {
          "title": "Pick From Available Slots",
          "subtitle": "msg subtite",
          "secondarySubtitle": "sec subtitle Auth Temp ",
          "tertiarySubtitle": "ter subtitle msg",
          "style": "large",
          "imageUrl": "https://example-bc2e1749c34e.com/resource/12.jpg"
        },
        "replyMessage": {
          "secondarySubtitle": "sec subtitle",
          "tertiarySubtitle": "ter subtitle",
          "style": "large",
          "imageUrl": "https://example-d2dae496be01.com/resource/13.jpg"
        },
        "location": {
          "longitude": 0.001,
          "radius": 5000,
          "title": "BLR"
        },
        "timeslots": [
          {
            "startTime": 1672755451528,
            "duration": 0
          }
        ],
        "timezone": "Asia/Kolkata",
        "title": "Eevnt title",
        "type": "TIME_PICKER"
      }
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "inReplyToMessageId": "ACCOUNT_600028667_1675417733748_APPLE_BUSINESS_CHAT_317_c23d7936-2f15-4eb5-ab30-d5a09bb2077b",
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019355338"
  ],
  "errors": []
}
```

#### iMESSAGE

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_600028667_1675417733748_APPLE_BUSINESS_CHAT_317_c23d7936-2f15-4eb5-ab30-d5a09bb2077b",
    "accountId": 600028667,
    "content": {
      "text": "",
      "attachment": {
        "type": "APP_LINK",
        "appId": "123",
        "appName": "sampleApp",
        "bId": "com.apple.messages.MSMessageExtensionBalloonPlugin:{team-id}:{ext-bundle-id}",
        "url": "aa",
        "useLiveLayout": false,
        "attachments": [
          {
            "type": "IMAGE",
            "url": "https://example-f68a514ac5a7.com/resource/14.jpg",
            "title": "attachment title",
            "description": "desc"
          }
        ],
        "receivedMessage": {
          "title": "testi1",
          "subtitle": "test1",
          "style": "large",
          "imageUrl": "https://example-7c7cc3a5f81a.com/resource/15.jpg"
        },
        "replyMessage": {
          "title": "testi1",
          "subtitle": "test1",
          "style": "icon",
          "imageUrl": "https://example-1d1929b12195.com/resource/16.jpg"
        }
      }
    },
    "taxonomy": {
      "campaignId": "2_-98"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019755398"
  ],
  "errors": []
}
```

#### APPLE_PAY

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "accountId": 600028667,
    "content": {
      "attachment": {
        "receivedMessage": {
          "imageUrl": "https://sprcdn-prod0-sam.sprinklr.com/9004/a91ed3d8-5bfc-4847-bacf-bf1192deeda2-1350917364/https___prod0-media-proxy.spri_p.jpg",
          "title": "Payment"
        },
        "replyMessage": {
          "style": "icon",
          "title": "Pay Here"
        },
        "paymentRequest": {
          "lineItems": [
            {
              "label": "keyboard",
              "amount": 50
            }
          ],
          "total": {
            "amount": 50,
            "label": "",
            "type": "final"
          },
          "countryCode": "US",
          "currencyCode": "USD",
          "requiredBillingContactFields": [
            "postalAddress"
          ],
          "requiredShippingContactFields": [
            "postalAddress"
          ],
          "shippingMethods": [
            {
              "amount": 50,
              "label": "Ship"
            }
          ],
          "applePay": {
            "supportedNetworks": [
              "masterCard"
            ],
            "merchantCapabilities": [
              "supportsDebit"
            ]
          }
        },
        "type": "APPLE_PAY",
        "paymentAccountId": "5c87581cc7f9c5183b60df87"
      }
    },
    "taxonomy": {
      "campaignId": "6_-98"
    },
    "inReplyToMessageId": "ACCOUNT_600028667_1675417733748_APPLE_BUSINESS_CHAT_317_c23d7936-2f15-4eb5-ab30-d5a09bb2077b",
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    }
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019777398"
  ],
  "errors": []
}
```

#### FORM

**Example - Request**

```bash
curl --location 'https://api3.sprinklr.com/{env}/api/v3/publishing/message' \
  --header 'Authorization: Bearer {Enter your Access Token}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "inReplyToMessageId": "ACCOUNT_600028667_1675417733748_APPLE_BUSINESS_CHAT_317_c23d7936-2f15-4eb5-ab30-d5a09bb2077b",
    "accountId": 600028667,
    "content": {
      "text": "",
      "attachment": {
        "messageTitle": "Message Title",
        "messageSubtitle": "messageSubtitle",
        "buttonTitle": "Click",
        "form": {
          "formTitle": "testForm",
          "repeatable": true,
          "minCount": 1,
          "maxCount": 10,
          "fields": [
            {
              "name": "fieldtest1",
              "description": "firstdes1",
              "type": "input",
              "picklistValues": [
                {
                  "label": "Click",
                  "value": "1"
                }
              ],
              "parentChild": false,
              "multivalued": false,
              "defaultValue": "2023/02/03",
              "additional": {}
            }
          ]
        },
        "submit": {
          "title": "submit1"
        },
        "showSummary": true,
        "receivedMessage": {
          "title": "rMTitle",
          "subtitle": "rMSubtitle",
          "style": "icon",
          "imageUrl": "https://example-9982cbe1650d.com/resource/17.jpg"
        },
        "replyMessage": {
          "title": "ReplyTitle",
          "subtitle": "ReplySubtitle",
          "style": "icon",
          "imageUrl": "https://example-a7a34635859f.com/resource/18.jpg"
        },
        "type": "FORM"
      }
    },
    "taxonomy": {
      "campaignId": "2_-98"
    },
    "toProfile": {
      "channelType": "APPLE_BUSINESS_CHAT",
      "channelId": "urn:mbid:AQAAY8Aa3+Spi5oJR9cO4V69HgReZG2oOJHvjBjRM4TWJW+IFxLMKClh322LdBGwy9I9msHFHyT17PSUR9+WaRdpo0fmh9mq1mduAVUmdYDyfON23npvSOTXA9B9CvP43onOHnCidad+RdG7avJU7qEjLwWol9c=",
      "screenName": "Apple User 56"
    },
    "approval": {}
  }'
```

**Example - Response**

```json
{
  "data": [
    "POST_600000019777347"
  ],
  "errors": []
}
```

## 6. Use Cases

##### 1. Publish interactive private messages across supported channels

Send structured messages rather than plain text using templates such as quick replies, cards, carousels, list pickers, forms, appointment requests, and payment requests. The appropriate template is selected through the attachment type, subject to the templates supported by the target channel.

##### 2. Provide predefined response options with Quick Replies

Publish QUICK_REPLY messages that present predefined response choices. Quick Replies are documented for Facebook, Instagram, Twitter, Sprinklr Live Chat, and Apple Business Chat.

##### 3. Present multiple options using cards and carousels

Publish cards or carousels containing structured information and interactive buttons. Carousel support is documented for Facebook, Instagram, and Sprinklr Live Chat, while card-based experiences are also documented for WhatsApp and Sprinklr Live Chat.