Carousel (Image)

post

https://partner.gupshup.io/partner/app/{appId}/templates

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Request Parameters

Key	Description	Value	Data Type	Required/Optional	Constraints
Authorization	Access Token for the application	{{PARTNER_APP_TOKEN}}	String	Required	Should be a valid Partner App Access Token
elementName	The name of a template. The element name is unique for a WABAs namespace.	{{ELEMENT_NAME}}	String	Required	elementName (not more than 180 char.) Mandatory fields
languageCode	Language code for the template. Refer to all the language codes here.	{{LANGUAGE_CODE}}	String	Optional	languageCode default value : `en_US`
content	The body of the template.	{{CONTENT}}	String	Required	content (not more than 1024 char.)
category	The category of your template.	{{CATEGORY}}	String	Required	Category Type: MARKETING UTILITY
vertical	TEXT	{{VERTICAL}}	String	Required	vertical (not more than 180 char.)
templateType	CAROUSEL	{{TEMPLATE_TYPE}}	String	Required	The type of template: CAROUSEL Cards only to be passed if template type is CAROUSEL
example	Template Example	{{EXAMPLE}}	String	Required
enableSample	Required for creating all types of templates	{{ENABLE_SAMPLE}}	true/false	Optional	if enableSample is true then exampleMedia
cards	Card list	\[{"headerType":"IMAGE","mediaUrl":"<https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg","mediaId":null,"exampleMedia":null,"body":"New> Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":\[{"type":"URL","text":"Buy now","url":"<https://www.luckyshrub.com/shop?promo={{1}}","buttonValue":"https://www.luckyshrub.com/shop?promo=","suffix":"exotic_produce_2023","example":["https://www.luckyshrub.com/shop?promo=exotic_produce_2023"]},{"type":"QUICK_REPLY","text":"Send> more like this"}]}	String	Required	Either of mediaUrl, mediaId or exampleMedia is required. If exampleMedia is not provided, the handleId / exampleMedia will be generated in the backend using the mediaUrl / mediaId. `[ { "headerType": "<IMAGE>", "mediaUrl": "<image url>", "mediaId": "<image id>", "exampleMedia": "<image handle id>", "body": "<card 1 body>", "sampleText": "<card 1 example>", "buttons": <button_list> } ]`
allowTemplateCategoryChange	Boolean value. If True, Meta will automatically update the template category as per the template content. The default value is False.	{{ALLOW_TEMPLATE_CATEGORY_CHANGE}}	true/false	Optional
appId	App ID to fetch the access token	{{APP_ID}}	String	Required	The Id should be a valid app Id of Gupshup The App must be associated with the account that owns the PARTNER_APP_TOKEN being used

Sample Request

curl --location --request POST 'https://partner.gupshup.io/partner/app/{{APP_ID}}/templates' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'elementName=caouseltemplate_kj' \
--data-urlencode 'languageCode=en' \
--data-urlencode 'content=Hey Gupshup! new products:' \
--data-urlencode 'category=MARKETING' \
--data-urlencode 'vertical=products' \
--data-urlencode 'templateType=CAROUSEL' \
--data-urlencode 'example=Hey Gupshup! new products:' \
--data-urlencode 'allowTemplateCategoryChange=false' \
--data-urlencode 'enableSample=true' \
--data-urlencode 'cards=[{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg","mediaId":null,"exampleMedia":null,"body":"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}","buttonValue":"https://www.luckyshrub.com/shop?promo=","suffix":"exotic_produce_2023","example":["https://www.luckyshrub.com/shop?promo=exotic_produce_2023"]},{"type":"QUICK_REPLY","text":"Send more like this"}]},{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg","mediaId":null,"exampleMedia":null,"body":"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}","buttonValue":"https://www.luckyshrub.com/shop?promo=","suffix":"exotic_produce_2023","example":["https://www.luckyshrub.com/shop?promo=exotic_produce_2023"]},{"type":"QUICK_REPLY","text":"Send more like this"}]},
{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg","mediaId":null,"exampleMedia":null,"body":"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}","buttonValue":"https://www.luckyshrub.com/shop?promo=","suffix":"exotic_produce_2023","example":["https://www.luckyshrub.com/shop?promo=exotic_produce_2023"]},{"type":"QUICK_REPLY","text":"Send more like this"}]},{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg","mediaId":null,"exampleMedia":null,"body":"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}","buttonValue":"https://www.luckyshrub.com/shop?promo=","suffix":"exotic_produce_2023","example":["https://www.luckyshrub.com/shop?promo=exotic_produce_2023"]},{"type":"QUICK_REPLY","text":"Send more like this"}]}]'

Sample Response

{
    "status": "success",
    "template": {
        "appId": "a41b30f4-d202-4fdb-911e-3a8fbfbfb797",
        "category": "MARKETING",
        "containerMeta": "{\"appId\":\"a41b30f4-d202-4fdb-911e-3a8fbfbfb797\",\"data\":\"Hey Gupshup! new products:\",\"cards\":[{\"headerType\":\"IMAGE\",\"mediaUrl\":\"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}\",\"sampleText\":\"New Year is round the corner User\",\"buttons\":[{\"type\":\"URL\",\"text\":\"Buy now\",\"url\":\"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this\"}]},{\"headerType\":\"IMAGE\",\"mediaUrl\":\"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}\",\"sampleText\":\"New Year is round the corner User\",\"buttons\":[{\"type\":\"URL\",\"text\":\"Buy now\",\"url\":\"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this\"}]},{\"headerType\":\"IMAGE\",\"mediaUrl\":\"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}\",\"sampleText\":\"New Year is round the corner User\",\"buttons\":[{\"type\":\"URL\",\"text\":\"Buy now\",\"url\":\"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this\"}]},{\"headerType\":\"IMAGE\",\"mediaUrl\":\"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}\",\"sampleText\":\"New Year is round the corner User\",\"buttons\":[{\"type\":\"URL\",\"text\":\"Buy now\",\"url\":\"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this\"}]}],\"sampleText\":\"Hey Gupshup! new products:\",\"enableSample\":true,\"editTemplate\":false,\"allowTemplateCategoryChange\":false,\"addSecurityRecommendation\":false}",
        "createdOn": 1715600418102,
        "data": "Hey Gupshup! new products:",
        "elementName": "caouseltemplate_kj",
        "id": "7efb9be8-c9b5-48e9-af0e-1e495b4ed2a3",
        "languageCode": "en",
        "languagePolicy": "deterministic",
        "meta": "{\"example\":\"Hey Gupshup! new products:\"}",
        "modifiedOn": 1715600418102,
        "namespace": "9c7fe92f_2a48_40ec_83d0_69c62a772433",
        "priority": 1,
        "quality": "UNKNOWN",
        "retry": 0,
        "stage": "NONE",
        "status": "PENDING",
        "templateType": "CAROUSEL",
        "vertical": "products",
        "wabaId": "104505526065633"
    }
}

Status Codes

Status Code	Response	Comment
Success
200	{ "status":"success", "template":{ "appId":"a41b30f4-d202-4fdb-911e-3a8fbfbfb797", "category":"MARKETING", "containerMeta":"{"appId":"a41b30f4-d202-4fdb-911e-3a8fbfbfb797","data":"Hey Gupshup! new products:","cards":[{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this"}]},{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this"}]},{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this"}]},{"headerType":"IMAGE","mediaUrl":"https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg\",\"body\":\"New Year is round the corner {{1}}","sampleText":"New Year is round the corner User","buttons":[{"type":"URL","text":"Buy now","url":"https://www.luckyshrub.com/shop?promo={{1}}\",\"example\":[\"https://www.luckyshrub.com/shop?promo=exotic_produce_2023\"]},{\"type\":\"QUICK_REPLY\",\"text\":\"Send more like this"}]}],"sampleText":"Hey Gupshup! new products:","enableSample":true,"editTemplate":false,"allowTemplateCategoryChange":false,"addSecurityRecommendation":false}", "createdOn":1715600418102, "data":"Hey Gupshup! new products:", "elementName":"caouseltemplate_kj", "id":"7efb9be8-c9b5-48e9-af0e-1e495b4ed2a3", "languageCode":"en", "languagePolicy":"deterministic", "meta":"{"example":"Hey Gupshup! new products:"}", "modifiedOn":1715600418102, "namespace":"9c7fe92f_2a48_40ec_83d0_69c62a772433", "priority":1, "quality":"UNKNOWN", "retry":0, "stage":"NONE", "status":"PENDING", "templateType":"CAROUSEL", "vertical":"products", "wabaId":"104505526065633" } }
Error
429	`{ "status": "error", "message": "Too Many Requests" }`	10 Requests per Minute
500	`{ "status": "error", "message": "Internal server error. Please try again later and If Issue still persist than contact Gupshup Dev Support" }`	For any Internal Error

Path Params

appId

string

required

Unique identifier of the app.

Form Data

elementName

string

required

The name of a template. Element name is unique for a WABAs namespace.

languageCode

string

Language code for the template. Refer to all the language codes here.

content

string

required

The body of the template

category

string

required

The category of your template.

vertical

string

required

vertical (not more than 180 char.)

templateType

string

required

Type of template

example

string

required

Template example

allowTemplateCategoryChange

boolean

Boolean value. If True, Meta will automatically update the category of the template as per the template content. Default value is False.

enableSample

boolean

Boolean value

cards

string

required

Card list

Headers

token

string

required

Your app token, please refer Get access token api to get the token from partner documentation.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json