Skip to main content
POST
/
templates
Create a new message template
curl --request POST \
  --url https://api.example.com/templates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Order Confirmation"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Order Confirmation",
  "category": "transactional",
  "rawBody": "Your order #{{orderId}} has been confirmed.",
  "whatsappTemplateName": "order_confirmation",
  "whatsappTemplateStatus": "approved",
  "createdAt": "2023-01-01T12:00:00Z",
  "updatedAt": "2023-01-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Template creation details including customer ID and template name

Request model for creating a new message template

​
customerId
string<uuid>
required

Unique identifier of the customer creating the template

​
name
string
required

Name of the template for identification purposes

Required string length: 1 - 100

Response

200 - application/json

Template created successfully

Response model containing template details

​
id
string<uuid>

Unique identifier of the template

​
customerId
string<uuid>

Customer ID associated with the template

​
name
string

Template name

​
category
enum<string>

Category of the template (e.g., transactional, marketing)

Available options:
transactional,
marketing,
alert
​
rawBody
string

Template content with variable placeholders

​
whatsappTemplateName
string

Associated WhatsApp template name if applicable

​
whatsappTemplateStatus
enum<string>

Approval status of WhatsApp template

Available options:
pending,
approved,
rejected
​
createdAt
string<date-time>

Template creation timestamp

​
updatedAt
string<date-time>

Last template update timestamp