Whatsapp Message Templates

List Whatsapp message templates

Changed on

Returns WhatsApp message templates owned by the authenticated account, including their current review state.

get/v2/whatsapp/message_templates

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/v2/whatsapp/message_templates
  • Auth: HTTP bearer

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

filter[waba_id]string

Filter by WABA ID

filter[category]'MARKETING' | 'UTILITY' | 'AUTHENTICATION'

Filter by category

filter[status]string

Filter by template status

filter[search]string

Search templates by name

Response

Successful response with Whatsapp template

Example response

{
  "data": [
    {
      "record_type": "whatsapp_message_template"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status