Skip to main content
POST
Required token scopes: Manage WhatsApp templates When a template is first created, it exists only locally and is not yet visible to WhatsApp. The template entity is internal, so it has properties unknown to WhatsApp such as the reply action, bot node, and departments. After creating a template, the next step is to Create or Update Localization, which defines all the properties required by WhatsApp - including the language, components (header, body, footer, buttons) and example variable values. Finally, once both the template and its localization have been created, you can Submit the Template for Approval. If you don’t specify a template name, one is generated automatically - save the generated name from the response to use when creating a localization and submitting.

Authorizations

Authorization
string
header
required

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

Path Parameters

accountId
string
required

The account ID of the channel in Texter. For WhatsApp channels this is the phone number connected to the account (e.g. 972586640430)

Body

application/json
title
string
required

Internal title shown in Texter

category
enum<string>
required

WhatsApp template category. WhatsApp may adjust this value upon submission based on the template's semantic classification

Available options:
MARKETING,
UTILITY
chatStatus
enum<integer>
required

The chat status after the recipient replies to the template: 0 = BOT, 1 = PENDING, 2 = ASSIGNED, 3 = RESOLVED

Available options:
0,
1,
2,
3
usage
enum<string>
required

Whether this template is intended to be sent individually (inbox) or in bulk (bulk)

Available options:
inbox,
bulk
name
string

The template name (which serves as its ID). Auto-generated if not specified. Must be unique per account. Only letters, numbers and underscores are allowed

Pattern: ^[a-zA-Z0-9_]+$
isDefault
boolean

Defaults to false. Only one template can be the default

departments
string[]

Department IDs that have access to this template

setBotNode
string

If chatStatus is 0 (BOT), the bot starts running from this specific node when the recipient replies. Must be an existing node in the channel's bot

responsibleAgent
string

Assign the chat to this agent (agent email in Texter) after the recipient replies. Can't be combined with responsibleDepartment

responsibleDepartment
string

Assign the chat to this department (department ID from Texter) after the recipient replies. Can't be combined with responsibleAgent

replyText
string

Text sent automatically when the recipient replies to the template

Response

The newly created template object. Field-by-field reference: The Template object

A WhatsApp template in Texter, including internal behavior (chat routing rules, departments, defaults) and provider state (WhatsApp approval status, localized content)

_id
string

Unique identifier of the template in Texter

Example:

"6891bb93481ccea320113a91"

name
string

Internal template name (also used as the template ID in API calls)

Example:

"bulk_marketing_272"

title
string

Human-readable title shown in Texter's UI

usage
enum<string>

How this template is intended to be sent: inbox (1-to-1) or bulk (broadcast)

Available options:
inbox,
bulk
chatStatus
enum<integer>

Status the chat moves to after the recipient replies to this template

Available options:
0,
1,
2,
3,
4
created
number

When the template was created (epoch ms)

updatedAt
string<date-time>
departments
string[]

Department IDs allowed to use this template. Can be empty

isDefault
boolean

Whether this is the default template for the account. Only one template can be default

setBotNode
string

Bot node to trigger after reply, if chatStatus routes to bot

bot
string

Specific bot to run after reply, if chatStatus routes to bot

replyText
string

Text automatically sent when the recipient replies to the template

responsibleAgent
string

Agent (email) the chat is assigned to after the recipient replies

responsibleDepartment
string

Department ID the chat is assigned to after the recipient replies

attachedFile
object

File automatically sent when the recipient replies, when configured

provider
string

Channel adapter that owns this template (relevant when multiple WhatsApp account types are connected)

channelInfo
object

The channel account this template belongs to

provider_template
object

The template as registered with WhatsApp

defaults
object

Default send values by language code, prefilled when sending the template if the caller does not provide overrides

localizationDrafts
object

Map of language code to draft localization (created but not yet submitted/approved)