WhatsApp Templates

Get a message template

Changed on

Retrieves one WhatsApp message template by SignalWire ID or Meta template ID. Use it to inspect content and approval status for a known template; use List message templates to discover or filter templates, or Send a message after the template is approved.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

get/api/messaging/whatsapp/templates/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/messaging/whatsapp/templates/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

The template ID — either the SignalWire ID (a UUID) or the Meta template ID (a numeric string). Both are accepted.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The template name. Lowercase letters, numbers, and underscores only.

category'utility' | 'marketing' | 'authentication' required

The category of a WhatsApp message template.

languagestring required

The template language code.

parameter_format'named' | 'positional' required

How a template's variable placeholders are referenced.

template_idstring required

Meta's identifier for the template.

template_status'approved' | 'archived' | 'deleted' | 'disabled' | 'flagged' | 'in_appeal' | 'limit_exceeded' | 'locked' | 'paused' | 'pending' | 'reinstated' | 'pending_deletion' | 'rejected' required

The Meta approval status of a template. A template must be approved before it can be used to send messages.

whatsapp_business_idstring uuid required

Universal Unique Identifier.

created_atstring required

The date and time when the template was created.

updated_atstring required

The date and time when the template was last updated.

discarded_atstring

The date and time when the template was discarded, if applicable.

Example response

{
  "name": "order_update",
  "components": [
    {
      "type": "BODY"
    }
  ],
  "language": "en_US",
  "template_id": "1164792772433648",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "discarded_at": "2024-01-15T10:30:00Z"
}

Changes

Some revisions have not been checked yet.