TEXT

Carousel

--data-urlencode 'cards'

LTO

--data-urlencode 'limitedOfferText={{limited offer text}}' 
--data-urlencode 'hasExpiration={{true/false}}' 
--data-urlencode 'isLTO=true

The type of template: TEXT, IMAGE, LOCATION, PRODUCT, CATALOG, LTO, CAROUSEL, VIDEO & DOCUMENT

CATALOG, LTO, CAROUSEL templates are not available with the On-premises API

CATALOG, LTO, CAROUSEL and PRODUCT templates are available for MARKETING & UTILITY category only.

Cards to be cards only to be passed if template type is CAROUSEL

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/VIDEO>",
            "mediaUrl": "<image/video url>",
            "mediaId": "<image/video id>",
            "exampleMedia": "<image/video handle id>",
            "body": "<card 1 body>",
            "sampleText": "<card 1 example>",
            "buttons": <button_list>
        }
    ]

Copy code example

[
    {"type":"PHONE_NUMBER","text":"Call Us","phone_number":"+919872329959"},
    {"type":"URL","text":"Book A Demo","url":"https://bookins.gupshup.io/{{1}}","example":["https://bookins.gupshup.io/abc"]},
    {"type":"URL","text":"test","url":"https://www.google.co.uk/","buttonValue":"https://www.google.co.uk/","suffix":""},
    {"type":"QUICK_REPLY","text":"Yes"}, {"type": "COPY_CODE","example": "250FF"}
]

Authentication category example

[
    {"type":"OTP","otp_type":"COPY_CODE","text":"Copy OTP"},
    {"type":"OTP", "otp-type": "ONE_TAP", "text":"Book A Demo", "autofill_text": "Autofill", #One-tap buttons only "package_name": "com.example.myapplication" #One-tap buttons only, "signature_hash": "K8a%2FAINcGX7", #One-tap buttons only},
]

Button list example

{
    "type":"BUTTONS",
    "buttons": [
        {
            "type": "QUICK_REPLY",
            "text": "Unsubscribe from Promos"
        },
        {
            "type":"QUICK_REPLY",
            "text": "Unsubscribe from All"
        }
    ]
  }
  

1. COPY_CODE
2. ONE_TAP

If otp_type is set to ONE_TAP, three additional parameters are required:

1. autofill_text
2. package_name
3. signature_hash

UTILITY templates cannot use COPY_CODE

Marketing template now have support for

1. Copy Code
2. Button List

Copy Code - Allows users to copy the code from the message. Only one copy code button is allowed in one template

Marketing and Utility templates have support for Button list

Button List - Allows upto 10 buttons to be embedded in the template.

Sublimits

1. Maximum of 2 URL buttons are permitted
2. Maximum of 1 button of type PHONE_NUMBER is permitted
3. Maximum of 10 buttons of type QUICK_REPLY is permitted

1. When TemplateType is CATALOG
   • Template Params should contain the productId which will be sent as thumbnail for the catalog (Must be the last element in templateParams list)

   •                                                                                     
             {
                 "id": "8985923d-682d-4bb7-b037-66b61c8c7877",
                 "params": ["a2py9opgpp"]
             }
                                                                                     
                                                                                 

2. When TemplateType is PRODUCT
   • Template Params should contain the productId which will be sent as thumbnail (last in the list)
   • Sections param must be provided with valid ids

                                                                                         
             {
                 "id":"3b9bf65b-979c-44d3-a269-dec2f20c4e52",
                 "params":[
                     "zqc2qfz5fm"
                 ],
                 "mpm":{
                     "sections":[
                         {
                             "title":"Products",
                             "products":[
                             "zqc2qfz5fm"
                             ]
                         },
                         {
                             "title":"Products2",
                             "products":[
                             "xyli96fcbn"
                             ]
                         }
                     ]
                 }
             }
                                                                                         
                                                                                     

   •                                                                             
     {
         "id": "007b7c0e-fc8d-4698-a9a8-3938151dd5da",
         "params": ["monday","2020-12-20","apps", "a2py9opgpp"]
     }
                                                                                 
                                                                             

   • When TemplateType is Carousel

     Carousel Template when created with mediaUrl

     {
         "type":"carousel",
         "cardHeaderType":"IMAGE",
         "cards":[
         {"link":"https://fastly.picsum.photos/id/13/2500/1667.jpg?hmac=SoX9UoHhN8HyklRA4A3vcCWJMVtiBXUg0W4ljWTor7s"},
         {"link":"https://fastly.picsum.photos/id/25/5000/3333.jpg?hmac=yCz9LeSs-i72Ru0YvvpsoECnCTxZjzGde805gWrAHkM"},
         {"link":"https://fastly.picsum.photos/id/28/4928/3264.jpg?hmac=GnYF-RnBUg44PFfU5pcw_Qs0ReOyStdnZ8MtQWJqTfA"},
         {"link":"https://fastly.picsum.photos/id/27/3264/1836.jpg?hmac=p3BVIgKKQpHhfGRRCbsi2MCAzw8mWBCayBsKxxtWO8g"}
     ]}

     
     

     Carousel Template when created with mediaId

     {
         "type":"carousel",
         "cardHeaderType":"IMAGE",
         "cards":[
         {"id":"1055910955598003"},
         {"id":"1055910955598003"},
         {"id":"1055910955598003"},
         {"id":"1055910955598003"}]
     }

   • When TemplateType is LTO

     Send message template:

     {"id":"667237b0-0e4f-42f7-ae70-4603bae593ff","params":["250FF"],"expiration":1714694865000}

MPM Template

• For MPM template, params must include all params including a product id (which is to be used as thumbnail (last in the list))
• For MPM template messages template section must be provided with valid Ids template={ "id":"3b9bf65b-979c-44d3-a269-dec2f20c4e52", "params":[ "zqc2qfz5fm" ], "mpm":{ "sections":[{ "title":"Products", "products":[ "zqc2qfz5fm" ] }, { "title":"Products2", "products":[ "xyli96fcbn" ] }] } }

Catalog Template

• Catalog template supported only on CAPI
• For catalog template Params should contain the productId which will be sent as thumbnail for the catalog (Must be the last element in templateParams list).

Location

LTO

    {
        "type": "image",
        "image": {
            "link": "",
            "id": ""
        }                                                                   
    }

Required when templateType is 'LOCATION'

Add video or image id/link for media LTO templates