Carousel

cURL

curl --location '{{api_front_base_url}}/wa/api/v1/template/msg' \
--header 'apikey: {{apiKey}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'channel=whatsapp' \
--data-urlencode 'source={{source phone number}}' \
--data-urlencode 'destination={{destination phone number}}' \
--data-urlencode 'src.name={{app_name}}' \
--data-urlencode 'template={"id":"<template_id>","params":[<list_of_template_parameters>]}' \
--data-urlencode 'message={{message}}'

📘

• Carousel templates can only be sent via CAPI apps.
• The template.params list will contain all variable parameter values, including those in main message bubble and individual cards, in order of their appearance
• Omit the postbackTexts parameter in the curl above if the template doesn’t have quick reply buttons, or if it has but there’s no need for postback text support.

Request Parameters

Form Parameters (Request Body)

template object structure:

message object structure:

cards object structure:

postbackTexts object structure:

postbackTexts object structure:

Status Codes