|
Authorization
|
Access Token for the application
|
\{PARTNER_APP_TOKEN}
|
String
|
Required
|
ā¢ Should be a valid Partner App Access Token
|
|
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
|
|
elementName
|
The name of a template. Element name is unique for a WABAs namespace.
|
\{ELEMENT_NAME}
|
String
|
Required
|
ā¢ elementName (not more than 200 char.) Mandatory fields
|
|
languageCode
|
Language code for the template. Refer to all the language codes
[here](https://support.gupshup.io/hc/en-us/articles/360013321939)
.
|
\{LANGUAGE_CODE}
|
String
|
optional
|
ā¢ languageCode default value : en_US
|
|
content
|
The body of the template. Character limit: 1028. For "Authentication" category the first line should be - \{\{1}} is your verification code.
|
|
String
|
NA
|
ā¢ content (not more than 1024 char.)
|
|
category
|
The category of your template. **Possible Values**: AUTHENTICATION, MARKETING and UTILITY.
If you submit the templates with the any other categories, you will receive an error Invalid category provided, kindly use category from these option AUTHENTICATION, MARKETING, UTILITY.
|
|
String
|
NA
|
ā¢ category (not more than 180 char.)
|
|
vertical
|
TEXT
|
|
String
|
NA
|
vertical (not more than 180 char.)
|
|
templateType
|
**TEXT**
Carousel--data-urlencode 'cards'**LTO**--data-urlencode 'limitedOfferText=
\{limited offer text}'
--data-urlencode 'hasExpiration=
\{true/false}'
--data-urlencode 'isLTO=true
|
|
String
|
NA
|
The type of template: TEXT, IMAGE, LOCATION, PRODUCT, CATALOG, LTO, CAROUSEL, VIDEO & DOCUMENTCATALOG, 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
|
|
example
|
Template Example
|
|
String
|
NA
|
|
|
enableSample
|
Required for creating all types of templates
|
|
true/false
|
NA
|
if enableSample is true then exampleMedia
|
|
header
|
Header of the template. Applicable for templateType = Text Character limit: 60. Not applicable for "Authentication" category.
|
|
String
|
NA
|
|
|
footer
|
Footer of the template. Character limit: 60. Not applicable for "Authentication" category, only set based on code_expiration_minutes value
|
|
String
|
NA
|
|
|
buttons
|
|
|
Array of objects
|
NA
|
|
|
exampleHeader
|
This is the header
|
|
String
|
NA
|
|
|
addSecurityRecommendation
|
Optionally for "Authentication" category a security disclaimer is added to content - For your security, do not share this code
|
|
Boolean
|
NA
|
true
|
|
codeExpirationMinutes
|
Optionally for "Authentication" category the following text is added to footer - This code expires in \ minutes. Code expiry time should be between 1 and 90 minutes.
|
|
Integer
|
NA
|
|
|
messageValidity
|
If we are unable to deliver a message to a WhatsApp user, we will retry the delivery for a period of time known as a time-to-live, TTL, or the message validity period.
|
Valid messageValidity property values
**Authentication templates**: 30 to 900 seconds (30 secs to 15 mins).
**Utility templates**: 30 to 43200 seconds (30 secs to 12 hours).
**Marketing templates**: 43200 to 2592000 (12 hours to 30 days)
|
Integer
|
NA
|
|
|
isCPR
|
To enable or disable CPR (Call permission request)
|
true/false
|
Boolean
|
Optional
|
|
|
parameterFormat
|
`Header component :
Already supports positional ({{1}}) ā Now supports named ({{sale_start_date}}).`
`Body component:
Already supports multiple positional params ({{1}}, {{2}}) ā Now supports named ({{order_id}}, {{customer_name}}).`
|
NAMED/POSITIONAL
Default will be positional
|
|
|
|