Skip to main content
POST
Create a new SMS template

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Human-readable template title shown in the composer picker (e.g., "Intro - new lead").

template
string
required

Template body containing {{firstName}}-style placeholders resolved against the contact at send time.

type
string
required

Template kind: sms, campaign, script, or automation. Automation templates ignore category.

category
string

Category slug (matches TemplateCategory.name) used to group templates in the picker; defaults to other when omitted for non-automation types.

Response

Template created

A reusable template (type: sms / campaign / script / automation). Returned by create/update template endpoints.

_id
string
required
name
string
required
template
string
required

Template body with {{firstName}}-style placeholders.

type
enum<string>
required
Available options:
sms,
email,
campaign,
script,
automation
category
string
organizationId
string
userId
string
createdBy
string
updatedBy
string
createdAt
string<date-time>
updatedAt
string<date-time>