Create a message template

POST

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

POST

/api/messaging/whatsapp/templates

$ curl -X POST https://{your_space_name}.signalwire.com/api/messaging/whatsapp/templates \
>      -H "Content-Type: application/json" \
>      -u "<project_id>:<api_token>" \
>      -d '{
>   "whatsapp_business_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>   "name": "order_update",
>   "language": "en_US",
>   "category": "utility",
>   "parameter_format": "positional",
>   "components": [
>     {
>       "type": "HEADER",
>       "example": {
>         "header_text": [
>           "Jane Smith"
>         ]
>       },
>       "format": "TEXT",
>       "text": "Order Update for {{1}}"
>     },
>     {
>       "type": "BODY",
>       "example": {
>         "body_text": [
>           [
>             "ORD-9821",
>             "out for delivery"
>           ]
>         ]
>       },
>       "text": "Your order {{1}} is currently {{2}}."
>     },
>     {
>       "type": "FOOTER",
>       "text": "Thank you for shopping with us."
>     },
>     {
>       "type": "BUTTONS",
>       "buttons": [
>         {
>           "text": "Track Order",
>           "type": "QUICK_REPLY"
>         },
>         {
>           "text": "Contact Support",
>           "type": "URL",
>           "url": "https://example.com/support"
>         }
>       ]
>     }
>   ]
> }'

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 }

Creates a message template and submits it to Meta for review. Approval typically takes from a few minutes to a few hours; poll the template’s template_status until it becomes 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.

Creates a message template and submits it to Meta for review. Approval typically takes from a few minutes to a few hours; poll the template's `template_status` until it becomes `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](/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) ```

Request

This endpoint expects an object.

whatsapp_business_idstringRequiredformat: "uuid"

The WhatsApp Business Account the template belongs to. List your accounts at GET /api/messaging/whatsapp/businesses.

namestringRequiredformat: "^[a-z0-9_]*$"<=512 characters

The template name. Maximum 512 characters; lowercase letters, numbers, and underscores only.

languagestringRequired

The template language code.

categoryenumRequired

The template category.

parameter_formatenumRequired

How the template's variable placeholders are referenced.

componentslist of objectsRequired

The template’s components. Must include a BODY component. Each component is an object whose fields depend on its type — see the request example.

Response

Response returned when a template is successfully created and submitted to Meta.

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_atstring

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

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error