Home
API Reference

Apply For Templates

post
https://partner.gupshup.io/partner/app//templates

Using this API, you can Create a template for a particular app

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

Unique identifier of the app.

Form Data
string
required

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

string

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

string
enum
required

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.

Allowed:
string
enum
required

The type of template: TEXT, IMAGE, LOCATION, VIDEO, DOCUMENT, PRODUCT and CATALOG

Allowed:
string
required

Character limit: 180

string
required

The body of the template. Character limit: 1028. For “Authentication” category the first line should be - {{1}} is your verification code.

string

Header of the template.

  1. Applicable for templateType = Text Character limit: 60.
  2. Not applicable for “Authentication” category and template type “CATALOG”
string

Footer of the template. Character limit: 60. Not applicable for “Authentication” category, only set based on code_expiration_minutes value

string

  • Used only if your template has a CTA. An example is also submitted if a URL button has variable parameter. For “Authentication” category OTP button type is supported with two otp_type:

    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
string
required

An example of the template.

boolean

Required for creating all types of templates.

boolean

Boolean value. If True, Meta will automatically update the category of the template as per the template content. Default value is False. If the category gets updated, you can view the oldCategory from the Get Templates API.

string

Not applicable for template type: CATALOG

boolean

Optionally for "Authentication" category a security disclaimer is added to content - For your security, do not share this code.

integer

Optionally for “Authentication” category the following text is added to footer - This code expires in <NUM_MINUTES> minutes. Code expiry time should be between 1 and 90 minutes.

integer

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 message_send_ttl_seconds 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)

Headers
string
required

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

Responses

Updated about 2 months ago

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

Updated about 2 months ago