List WhatsApp Message Templates

gethttps://api.telnyx.com/v2/whatsapp_business_accounts/{id}/whatsapp_message_templates

List WhatsApp Message Templates

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/whatsapp_business_accounts/12ade33a-21c0-473b-b055-b3c836e1c292/whatsapp_message_templates?category=string&language=string"

Parameters

In Path
id
string
(uuid)
required
Identifies the WhatsApp Business Account
Example: "12ade33a-21c0-473b-b055-b3c836e1c292"
In Query
category
string
optional
The template category
Options: [ "ACCOUNT_UPDATE", "PAYMENT_UPDATE", "PERSONAL_FINANCE_UPDATE", "SHIPPING_UPDATE", "RESERVATION_UPDATE", "ISSUE_RESOLUTION", "APPOINTMENT_UPDATE", "TRANSPORTATION_UPDATE", "TICKET_UPDATE", "ALERT_UPDATE", "AUTO_REPLY" ]
language
string
optional
The language of the whatsapp message template
Options: [ "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", "vi", "zu" ]
name
string
optional
A name identifying this whatsapp message template
quality_score
string
optional
The score of the whatsapp message template
rejected_reason
string
optional
The reason why a message template was rejected by Whatsapp
limit
string
optional
The maximum number of message_templates to be returned on a query, we may return less than the limit number even if more pages are available.
Example: "10"
before
string
optional
Indicates that this is a query for entries before the given cursor
Example: "QAVCEP"
after
string
optional
Indicates that this is a query for entries after the given cursor
Example: "QAVCEP"
status
string
optional
Identifies the whatsApp Message Template status
Example: "APPROVED"

Responses

200
WhatsApp Message Template
default
Unexpected error

Success Response

{
  "data": [
    {
      "category": "APPOINTMENT_UPDATE",
      "components": [
        {
          "format": "VIDEO",
          "text": "Hello, {{1}}! Your appointment with {{2}} has been updated.",
          "type": "text"
        }
      ],
      "id": "23492349423",
      "language": "en_US",
      "name": "sample_happy_hour_announcement",
      "quality_score": {
        "score": "UNKNOWN"
      },
      "record_type": "whatsapp_message_template",
      "rejected_reason": "NONE",
      "status": "APPROVED"
    }
  ],
  "meta": {
    "cursors": {
      "after": "MQZDZD",
      "before": "MQZDZD"
    },
    "next": "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[after]=MQZDZD&page[limit]=1",
    "previous": "/v2/whatsapp_business_accounts/4444451-4222-9222-3bd5555501c0/whatsapp_message_templates?page[before]=MQZDZD&page[limit]=1"
  }
}

...

posthttps://api.telnyx.com/v2/whatsapp_business_accounts/{id}/whatsapp_message_templates

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/whatsapp_business_accounts/{id}/whatsapp_message_templates/{name}

...

...

Parameters

Responses

Success Response

Was this page helpful?