List message templates

GET

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

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.

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](/docs/apis/rest/whatsapp/retrieve-whatsapp-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](/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) ```

Query parameters

whatsapp_business_idstringOptionalformat: "uuid"

Filter to templates belonging to a specific WhatsApp Business Account.

statusenumOptional

Filter by approval status.

Response

The request has succeeded.

datalist of objects

List of message templates.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

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

$	curl https://{your_space_name}.signalwire.com/api/messaging/whatsapp/templates \
>	-u "<project_id>:<api_token>"