v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Message Templates

Get message template

Retrieve a single message template by ID. Validates that the template belongs to a WhatsApp Official channel account owned by the authenticated user.

get/v2/message-templates/{id}

Path parameters

idstring uuid required

Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

UUID

Headers

api-tokenstring required

API Token

Response

A message template object

statusinteger

Response status

Example response

{
  "status": 200,
  "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}}"
      ]
    }
  }
}