MessagingWhatsApp

Get a message template

View as MarkdownOpen in Claude
Retrieves one WhatsApp message template by SignalWire ID or Meta template ID. Use it to inspect content and approval status for a known template; use [List message templates](/docs/apis/rest/whatsapp/list-whatsapp-templates) to discover or filter templates, or [Send a message](/docs/apis/rest/messages/create-message) after the template is 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) ```

Path parameters

idstringRequired

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

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.
Allowed values:
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.
Allowed values:
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

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error