WhatsApp Templates

List message templates

Changed on

Lists the project's reusable WhatsApp message templates. Use it to find an approved template before sending business-initiated messages; a template must have template_status of approved before use. Use Get a message template when you already have its SignalWire or Meta ID.

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

Request

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

Query parameters

whatsapp_business_idstring uuid

Universal Unique Identifier.

Filter to templates belonging to a specific WhatsApp Business Account.

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

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

Filter by approval status.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "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.