Skip to main content
POST
Submit a message template for review
Submit a draft message template for review. The template moves from draft to pending and our team takes over from there: the per-country registrations are filed with the carriers and reviewed, and the template reaches ready only once every country you asked for is registered. Poll Retrieve a message template to follow the per-country progress in region_statuses. A country that needs a sender registration also needs a monthly_volume of at least 1,000 on the template, and company registration details on your account. If we hold none, the submission is refused with missing_company_details.

Authorizations

Authorization
string
header
required

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

Path Parameters

template_id
string
required

The identifier of the template.

Response

OK

id
string
required

The identifier of the template, to pass as template_id when sending a message.

Example:

"template_01k8ap1btqf5r9fq2c8ax5fhc9"

type
enum<string>
required

What the template is used for. Possible values are:

  • transactional - A message triggered by an action of the recipient.
  • marketing - A promotional message, subject to marketing rules.
Available options:
transactional,
marketing
name
string
required

The name of the template.

Example:

"Acme Receipts"

status
enum<string>
required

Where the template stands in the approval flow. Possible values are:

  • draft - Yours to edit. Nothing is sent with it yet.
  • pending - Submitted, and waiting on our review and on the per-country registrations.
  • ready - Approved and usable in every country you asked for.
  • rejected - Refused. Contact support for the reason.
Available options:
draft,
pending,
ready,
rejected
channels
enum<string>[]
required

The channels the template can be delivered over.

Available options:
sms,
rcs,
whatsapp,
viber,
zalo,
telegram
variables
string[]
required

The placeholder names found in the variants, to fill in when sending.

Example:
variants
object[]
required

The wording of the message, one entry per locale.

default_locale
string
required

The locale used when the recipient's own locale has no variant.

Example:

"en"

countries
object[]
required

The countries the template works in, with the monthly volume recorded for each.

region_statuses
object
required

The readiness of the template per country, keyed by ISO 3166-1 alpha-2 country code.

created_at
string<date-time>
required

The date and time when the template was created.

Example:

"2024-01-01T12:00:00Z"