Create a new WhatsApp message template. Templates must be approved by WhatsApp before they can be used in messages.
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);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
template = client.whatsapp.templates.create(
category="MARKETING",
components=[{
"format": "TEXT",
"type": "HEADER",
}],
language="language",
name="name",
waba_id="waba_id",
)
print(template.data)
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.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
Response
Template created
data
object
Show child attributes
Was this page helpful?
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);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
template = client.whatsapp.templates.create(
category="MARKETING",
components=[{
"format": "TEXT",
"type": "HEADER",
}],
language="language",
name="name",
waba_id="waba_id",
)
print(template.data)