View as Markdown Open in ChatGPT Open in Claude
POST
RCS API · TEMPLATES · v1.0

create-template - CAROUSEL

https://api.example.com/rcs/api/v1/create-template
infoOverview

About this API

MethodPOST
Versionv1.0
Base URLhttps://api.example.com/rcs
Content Typeapplication/json
keySecurity

Authentication

This endpoint does not require authentication.

uploadInput

Request Body

Send a application/json payload. Replace placeholder values with data from your integration.

Top-Level Fields

NameTypeRequirementDescription
botIdstringNot specifiedRequest value for botId.
templateNamestringNot specifiedRequest value for templateName.
templateTypestringNot specifiedRequest value for templateType.
botMessageTypestringNot specifiedRequest value for botMessageType.
isSMSFallbackRequiredbooleanNot specifiedRequest value for isSMSFallbackRequired.
richCardCarouselDetailsobjectNot specifiedRequest value for richCardCarouselDetails.
{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}
{
  "type": "object",
  "properties": {
    "botId": {
      "type": "string"
    },
    "templateName": {
      "type": "string"
    },
    "templateType": {
      "type": "string"
    },
    "botMessageType": {
      "type": "string"
    },
    "isSMSFallbackRequired": {
      "type": "boolean"
    },
    "richCardCarouselDetails": {
      "type": "object",
      "properties": {
        "cardWidth": {
          "type": "string"
        },
        "cardsList": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "cardId": {
                "type": "string"
              },
              "cardMedia": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  }
                }
              },
              "cardTitle": {
                "type": "string"
              },
              "mediaType": {
                "type": "string"
              },
              "cardDescription": {
                "type": "string"
              },
              "suggestionsList": {
                "type": "array",
                "items": {}
              }
            }
          }
        },
        "mediaHeight": {
          "type": "string"
        }
      }
    }
  }
}
codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

shield_lockCredentials protectedAdd secrets only in your secure server environment.
downloadSDK
curl --request POST 'https://api.example.com/rcs/api/v1/create-template' \
  --header 'Content-Type: application/json' \
  --data '{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}'
const response = await fetch('https://api.example.com/rcs/api/v1/create-template', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "botId": "68218acedb298103bc8d5931",
    "templateName": "11_pdf_dy",
    "templateType": "carousel",
    "botMessageType": "PROMOTIONAL",
    "isSMSFallbackRequired": false,
    "richCardCarouselDetails": {
      "cardWidth": "SMALL_WIDTH",
      "cardsList": [
        {
          "cardId": "123",
          "cardMedia": {
            "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
          },
          "cardTitle": "Greetings",
          "mediaType": "pdf",
          "cardDescription": "Greetings !",
          "suggestionsList": []
        },
        {
          "cardId": "123",
          "cardMedia": {
            "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
          },
          "cardTitle": "Greetings",
          "mediaType": "image",
          "cardDescription": "Greetings !",
          "suggestionsList": []
        }
      ],
      "mediaHeight": "SHORT_HEIGHT"
    }
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
const response = await fetch('https://api.example.com/rcs/api/v1/create-template', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "botId": "68218acedb298103bc8d5931",
    "templateName": "11_pdf_dy",
    "templateType": "carousel",
    "botMessageType": "PROMOTIONAL",
    "isSMSFallbackRequired": false,
    "richCardCarouselDetails": {
      "cardWidth": "SMALL_WIDTH",
      "cardsList": [
        {
          "cardId": "123",
          "cardMedia": {
            "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
          },
          "cardTitle": "Greetings",
          "mediaType": "pdf",
          "cardDescription": "Greetings !",
          "suggestionsList": []
        },
        {
          "cardId": "123",
          "cardMedia": {
            "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
          },
          "cardTitle": "Greetings",
          "mediaType": "image",
          "cardDescription": "Greetings !",
          "suggestionsList": []
        }
      ],
      "mediaHeight": "SHORT_HEIGHT"
    }
  })
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);
import json
import requests

url = 'https://api.example.com/rcs/api/v1/create-template'
headers = {
  "Content-Type": "application/json"
}
payload = json.loads(r'''{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}''')
response = requests.post(url, headers=headers, json=payload)

response.raise_for_status()
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
String body = """
{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}
""";
var request = HttpRequest.newBuilder(URI.create("https://api.example.com/rcs/api/v1/create-template"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(body))
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
<?php
$curl = curl_init();
$payload = '{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}';
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.example.com/rcs/api/v1/create-template',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ["Content-Type: application/json"],
    CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
var json = """
{
  "botId": "68218acedb298103bc8d5931",
  "templateName": "11_pdf_dy",
  "templateType": "carousel",
  "botMessageType": "PROMOTIONAL",
  "isSMSFallbackRequired": false,
  "richCardCarouselDetails": {
    "cardWidth": "SMALL_WIDTH",
    "cardsList": [
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]"
        },
        "cardTitle": "Greetings",
        "mediaType": "pdf",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      },
      {
        "cardId": "123",
        "cardMedia": {
          "url": "https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png"
        },
        "cardTitle": "Greetings",
        "mediaType": "image",
        "cardDescription": "Greetings !",
        "suggestionsList": []
      }
    ],
    "mediaHeight": "SHORT_HEIGHT"
  }
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.example.com/rcs/api/v1/create-template", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
)

func main() {
    request, err := http.NewRequest("POST", "https://api.example.com/rcs/api/v1/create-template", bytes.NewBufferString("{\n  \"botId\": \"68218acedb298103bc8d5931\",\n  \"templateName\": \"11_pdf_dy\",\n  \"templateType\": \"carousel\",\n  \"botMessageType\": \"PROMOTIONAL\",\n  \"isSMSFallbackRequired\": false,\n  \"richCardCarouselDetails\": {\n    \"cardWidth\": \"SMALL_WIDTH\",\n    \"cardsList\": [\n      {\n        \"cardId\": \"123\",\n        \"cardMedia\": {\n          \"url\": \"https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/665873c0c660399dce731130/6690deca0e202b00019c034d/6892f51ec1bc06845cbf4e42/[pdf]\"\n        },\n        \"cardTitle\": \"Greetings\",\n        \"mediaType\": \"pdf\",\n        \"cardDescription\": \"Greetings !\",\n        \"suggestionsList\": []\n      },\n      {\n        \"cardId\": \"123\",\n        \"cardMedia\": {\n          \"url\": \"https://rcs-bot-media-public.s3.ap-south-1.amazonaws.com/66979a3cde3d1114698a2fc2/669a4ba982ab2f0001956969/66a0e437c7dc530001d8be8b/carouselCardMedia_0_1721820215352_Discount.png\"\n        },\n        \"cardTitle\": \"Greetings\",\n        \"mediaType\": \"image\",\n        \"cardDescription\": \"Greetings !\",\n        \"suggestionsList\": []\n      }\n    ],\n    \"mediaHeight\": \"SHORT_HEIGHT\"\n  }\n}"))
    if err != nil { panic(err) }
    request.Header.Set("Content-Type", "application/json")
    request.Header.Set("Accept", "application/json")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}
downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}
{}
ruleHTTP Responses

Status Codes

200Successful response
Global API SearchProducts, versions, endpoints, paths, and payload fields
Esc
Full search page
manage_searchSearch the complete API catalogEnter at least two characters to begin.