Create a carousel RCS template

Creates a horizontal carousel of 2–10 rich cards. Sent as application/json with a native nested cards array. Each card has its own header, body, optional media (public media_url or base64 data URI media_file) and 0–2 buttons. Homogeneity rule: every card must declare the same number of buttons, in the same order of types.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Friendly name persisted in the template registry.

string
length ≤ 306

Optional fallback delivered as SMS when the RCS send fails.

default_variables
array of objects

Optional fallback values for {{N}} placeholders inside each card body.

default_variables
cards
array of objects
required
length between 2 and 10

2 to 10 cards rendered horizontally.

cards*
string
required
length ≤ 100

Header text shown above the card media.

string
required
length ≤ 1600

Card body. May reference variables via {{N}}.

uri

Public media URL for this card. Mutually exclusive with media_file.

file

Media file upload for this card. Sent inline inside the JSON body as a base64 data URI (data:<mime>;base64,<payload>); the request is application/json, NOT multipart/form-data. The format: binary annotation is the trigger that makes the readme.io API Explorer (and Insomnia) render a file-attach widget that serialises the chosen file into this data URI shape on submit; the surrounding application/json content-type keeps SDK generators on the JSON code path. Mutually exclusive with media_url. Limit: 5 MB decoded.

buttons
array of objects
length between 0 and 2

0 to 2 interactive buttons per card. The number and order of types must match across every card in the carousel.

buttons
string
required
length ≤ 100

Header text shown above the card media.

string
required
length ≤ 1600

Card body. May reference variables via {{N}}.

uri

Public media URL for this card. Mutually exclusive with media_file.

file

Media file upload for this card. Sent inline inside the JSON body as a base64 data URI (data:<mime>;base64,<payload>); the request is application/json, NOT multipart/form-data. The format: binary annotation is the trigger that makes the readme.io API Explorer (and Insomnia) render a file-attach widget that serialises the chosen file into this data URI shape on submit; the surrounding application/json content-type keeps SDK generators on the JSON code path. Mutually exclusive with media_url. Limit: 5 MB decoded.

buttons
array of objects
length between 0 and 2

0 to 2 interactive buttons per card. The number and order of types must match across every card in the carousel.

buttons
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json