Multicard Template Creation

Overview

This API allows you to create multiple RCS templates with a slider configuration. The slider type template lets you add multiple cards to the message, where each card can contain different content such as images, text, and interactive buttons. These types of templates are ideal for promotional offers, product galleries, or multiple steps in an onboarding process.

API Endpoint

POST https://{{your_domain}}/api/v1.0/{{key}}/rcs_templates

URL Parameters:

• {{key}}: The account key in the URL should be replaced with your actual account key. .

HTTP Method

• POST: This method is used to send the data to create a new RCS template.

Headers

• Content-Type: application/json
• Authorization: Bearer <your_access_token> Replace <your_access_token> with your actual Bearer token for authentication.

Request Payload

The request body should be a JSON object containing the RCS template details. Below is an example of the JSON payload for creating a new RCS template:

Example Request Payload:

{
  "name": "template_name",
  "type": "advance",
  "advance_types": "slider",
  "thumbnail_alignment": "left",
  "card_width": "small",
  "components": [
    {
      "cards": [
        {
          "title": "title_one",
          "description": "description_one",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://example.com/image.png"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        },
        {
          "title": "title_two",
          "description": "description_two",
          "media": {
            "height": "MEDIUM",
            "fileUrl": "https://example.com/image.png"
          },
          "buttons": [
            {
              "type": "url",
              "text": "link",
              "url": "https://example.com"
            },
            {
              "type": "call",
              "text": "call now",
              "number": "9198xxxxxxxx"
            }
          ]
        }
      ]
    }
  ]
}

Field Descriptions:

Field Name	Type	Description
name	string	The name of the template (e.g., "template_one"). This is used for identification.
type	string	The type of template. For an advance template, this should be "advance".
advance_types	string	The type of advance template. For a slider template, this should be "slider".
thumbnail_alignment	string	The alignment of the thumbnail for the media. Can be “left” or “right”.
card_width	string	The width of each card in the template. Options could include “small”, “medium”, or “large”.
components	array	An array that contains the template components (e.g., cards).
cards	array	A list of cards in the template, each representing a different content block.
title	string	The title of the card (e.g., "title_one").
description	string	A description or content for the card (e.g., "description_one").
media	object	The media object for the card, containing the height and fileUrl.
height	string	The height of the media. This can be “SMALL”, “MEDIUM”, or “LARGE”.
fileUrl	string	The URL of the image or media file. Example: "https://example.com/image.png".
buttons	array	A list of buttons to be included on the card. Each button can have a different type (e.g., “url” or “call”).
type	string	The type of button. Can be “url” for a link button or “call” for a call button.
text	string	The text displayed on the button (e.g., "link", "call now").
url	string	The URL to open when the “url” button is clicked. Example: "https://example.com".
number	string	The phone number to be called when the “call” button is clicked. Example: "9198xxxxxxxx".

Success Response

If the template is successfully created, you will receive a 200 OK HTTP status, along with the details of the newly created template.

Example Response:

{
    "id": "3232",
    "status": "PENDING",
    "type": "ADVANCE"
}