Create RCS Carousel Template

Send template creation details in the JSON request body. Use this API to create text templates, single rich cards, or multi-card carousel templates.

Body Params
string

Enter the message type you want to create.

payload
object
Headers
string
required

Enter your API key from the RCS Dashboard.

string
required

Must be application/json.

string

Optional bot ID. If missing, the default bot is used.

Responses
200

Template created successfully.

With suggestions

{
  "message": "Template created successfully",
  "payload": {
    "name": "text_message_demo",
    "type": "text_message",
    "botId": "OCHhY1alm8nJfSnj",
    "textMessageContent": "Time to go big or go home because it's India VS Australia FINALS!",
    "suggestions": [
      {
        "suggestionType": "reply",
        "postback": "click_to_win",
        "displayText": "Click to Win"
      },
      {
        "suggestionType": "url_action",
        "postback": "answer_and_win",
        "displayText": "Answer and Win",
        "url": "https://brandx.onelink.me/"
      },
      {
        "suggestionType": "dialer_action",
        "postback": "call_now_fast",
        "displayText": "Call Now Fast",
        "phoneNumber": "+919876543212"
      }
    ],
    "createdViaApi": true
  },
  "status": "Success"
}

Without suggestions

{
  "message": "Template created successfully",
  "payload": {
    "name": "text_message_demo",
    "type": "text_message",
    "botId": "OCHhY1alm8nJfSnj",
    "textMessageContent": "Time to go big or go home because it's India VS Australia FINALS!",
    "createdViaApi": true
  },
  "status": "Success"
}
400

Template creation failed.

Template already exists

{
  "error": "Template with same name is already present.",
  "message": "Template creation failed",
  "status": "Failure"
}

Missing field

{
  "error": "missing required field: rcs_type",
  "message": "Template creation failed",
  "status": "Failure"
}

Name length validation

{
  "error": "The length of 'template_name' cannot be more than 20 characters",
  "message": "Template creation failed",
  "status": "Failure"
}
Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here!