Sign in

v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Template

Get Templates

Get Templates

get/v2/templates

Query parameters

status'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'ALL'

Template status

Example:PENDING

Template status

namestring

Template name

Example:test_template

Template name

language'af' | 'sq' | 'ar' | 'az' | 'bn' | 'bg' | 'ca' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'en_US' | 'et' | 'fil' | 'fi' | 'fr' | 'ka' | 'de' | 'el' | 'gu' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'ga' | 'it' | 'ja' | 'kn' | 'kk' | 'rw_RW' | 'ko' | 'ky_KG' | 'lo' | 'lv' | 'lt' | 'mk' | 'ms' | 'ml' | 'mr' | 'nb' | 'fa' | 'pl' | 'pt_BR' | 'pt_PT' | 'pa' | 'ro' | 'ru' | 'sr' | 'sk' | 'sl' | 'es' | 'es_AR' | 'es_ES' | 'es_MX' | 'sw' | 'sv' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'uz'

Template language

Example:en

Template language

category'MARKETING' | 'UTILITY'

Template category

Example:MARKETING

Template category

wabaPhoneNumbersstring

Comma separated waba phone numbers

Example:919999999999,918888888888

Waba Phone Numbers

allWabaPhoneNumbersboolean

If set to true, returns templates for all Waba Phone Numbers

Example:true

If set to true, returns templates for all Waba Phone Numbers

Response

Get Templates

idnumber required

Template ID

namestring required

Template Name

language'af' | 'sq' | 'ar' | 'az' | 'bn' | 'bg' | 'ca' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'hr' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'en_US' | 'et' | 'fil' | 'fi' | 'fr' | 'ka' | 'de' | 'el' | 'gu' | 'ha' | 'he' | 'hi' | 'hu' | 'id' | 'ga' | 'it' | 'ja' | 'kn' | 'kk' | 'rw_RW' | 'ko' | 'ky_KG' | 'lo' | 'lv' | 'lt' | 'mk' | 'ms' | 'ml' | 'mr' | 'nb' | 'fa' | 'pl' | 'pt_BR' | 'pt_PT' | 'pa' | 'ro' | 'ru' | 'sr' | 'sk' | 'sl' | 'es' | 'es_AR' | 'es_ES' | 'es_MX' | 'sw' | 'sv' | 'ta' | 'te' | 'th' | 'tr' | 'uk' | 'ur' | 'uz' required

Template Language

category'MARKETING' | 'UTILITY' required

Template Category

status'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' required

Template Status

rejectedReasonstring required

Template Rejected Reason

createdBystring required

Template Created By

wabaPhoneNumberstring required

Waba Phone Number

Example response

[
  {
    "language": "en",
    "category": "MARKETING",
    "status": "PAUSED",
    "rejectedReason": "Template Rejected Reason",
    "createdBy": "Creater_Name",
    "wabaPhoneNumber": "14155238886",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "variables": [
          {
            "name": "variable_1",
            "mediaUrl": "https://placeholder.com/150",
            "fileName": "Example File Name"
          }
        ],
        "buttons": [
          {
            "type": "URL",
            "text": "Button Text",
            "variables": [
              {
                "parameter": "some-url-path"
              }
            ]
          }
        ]
      }
    ]
  }
]