Sign in
WhatsApp Templates

Update a message template

Changes a WhatsApp template's category, components, or both. Use it while the template is still awaiting approval; an approved template cannot be updated and must be deleted and recreated. This operation edits reusable template content and does not send a message.

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.

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

Path parameters

idstring required

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

Request body

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

The category of a WhatsApp message template.

Example request

{
  "components": [
    {
      "type": "BODY"
    }
  ]
}

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

Changed in 5 of the 137 revisions of this API.23

Of the 137 revisions, 3 have a changelog that could not be searched.