Skip to main content
POST
/
whatsapp
/
message_templates
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const template = await client.whatsapp.templates.create({
  category: 'MARKETING',
  components: [{ format: 'TEXT', type: 'HEADER' }],
  language: 'language',
  name: 'name',
  waba_id: 'waba_id',
});

console.log(template.data);
{
  "data": {
    "id": "<string>",
    "record_type": "whatsapp_message_template",
    "template_id": "<string>",
    "name": "<string>",
    "category": "MARKETING",
    "language": "<string>",
    "status": "<string>",
    "rejection_reason": "<string>",
    "components": [
      {}
    ],
    "whatsapp_business_account": {
      "id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
waba_id
string
required

The WhatsApp Business Account ID.

​
name
string
required

Template name. Lowercase letters, numbers, and underscores only.

​
category
enum<string>
required

Template category: AUTHENTICATION, UTILITY, or MARKETING.

Available options:
MARKETING,
UTILITY,
AUTHENTICATION
​
language
string
required

Template language code (e.g. en_US, es, pt_BR).

​
components
object[]
required

Template components defining message structure. Passed through to Meta Graph API. Templates with variables must include example values. Supports HEADER, BODY, FOOTER, BUTTONS, CAROUSEL and any future Meta component types.

A template component. Additional Meta component types not listed here are also accepted.

Response

Template created

​
data
object