v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Message Templates

List message templates

Retrieve a paginated list of message templates linked to a WhatsApp Official channel account. The channel_account_id query parameter is required and must belong to the authenticated owner.

get/v2/message-templates

Query parameters

channel_account_idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

UUID of the channel account (required)

limitinteger

Max number of rows returned

offsetinteger

Number of rows skipped of the result

pageinteger

Select the page of the result

Headers

api-tokenstring required

API Token

Response

A paginated list of message templates

statusinteger

Response status

total_countinteger

Total items based on current filters

pageinteger

Current page

total_pagesinteger

Total pages based on current filters

has_nextboolean

Indicates that has next page

has_previousboolean

Indicates that has previous page

Example response

{
  "status": 200,
  "total_count": 50,
  "page": 1,
  "total_pages": 10,
  "has_next": true,
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "external_id": "123456789",
      "name": "welcome_message",
      "status": "APPROVED",
      "language": "pt_BR",
      "category": "MARKETING",
      "components": [
        {
          "type": "BODY",
          "text": "Hello {{1}}, welcome!",
          "format": "TEXT"
        }
      ],
      "variables": {
        "body": [
          "{{1}}"
        ]
      }
    }
  ]
}