Update a message template

PATCH

https://{your_space_name}.signalwire.com/api/messaging/whatsapp/templates/:id

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.

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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequired

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

Request

This endpoint expects an object.

categoryenumOptional

The updated template category. Required if components is omitted.

componentslist of objectsOptional

The updated components. Required if category is omitted.

Response

The request has succeeded.

idstringformat: "uuid"

The SignalWire identifier of the template.

namestring

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

categoryenum

The template category.

componentslist of objects

The template’s components (header, body, footer, buttons).

languagestring

The template language code.

parameter_formatenum

How the template's variable placeholders are referenced.

template_idstring

Meta's identifier for the template.

template_statusenum

The Meta approval status of the template.

whatsapp_business_idstringformat: "uuid"

The SignalWire identifier of the WhatsApp Business Account the template belongs to.

created_atstring

The date and time when the template was created.

updated_atstring

The date and time when the template was last updated.

discarded_atstringOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X PATCH https://{your_space_name}.signalwire.com/api/messaging/whatsapp/templates/id \
>	-H "Content-Type: application/json" \
>	-u "<project_id>:<api_token>" \
>	-d '{}'

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "order_update",
4	"category": "utility",
5	"components": [
6	{
7	"type": "BODY"
8	}
9	],
10	"language": "en_US",
11	"parameter_format": "positional",
12	"template_id": "1164792772433648",
13	"template_status": "approved",
14	"whatsapp_business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
15	"created_at": "2024-01-15T10:30:00Z",
16	"updated_at": "2024-01-15T10:30:00Z",
17	"discarded_at": "2024-01-15T10:30:00Z"
18	}