Skip to main content
POST
Submeter template

Authorizations

Authorization
string
header
required

Chave de API do projeto, no formato rt_live_... ou rt_test_..., enviada como Authorization: Bearer <chave>.

Body

application/json
channel
string
required

Canal ao qual o template pertence (chan_...).

Example:

"chan_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

name
string
required

Nome do template.

Example:

"confirmacao_pedido"

language
string
required

Código de idioma, por exemplo pt_BR ou en_US.

Example:

"pt_BR"

category
enum<string>
required

Categoria do template: marketing, utility ou authentication.

Available options:
marketing,
utility,
authentication
body_text
string
required

Corpo do template, com placeholders posicionais {{1}}, {{2}}, …

Example:

"Olá {{1}}! Seu pedido {{2}} foi confirmado."

components
object

Componentes opcionais: cabeçalho de texto ou de mídia, rodapé e até 10 botões. Omita o campo para um template só de texto.

Response

Recurso criado

id
string
required

Identificador do template.

Example:

"tmpl_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

channel
string
required

Canal ao qual o template pertence.

Example:

"chan_01J8ZK9M3Q7XABCDEFGHJKMNPQ"

name
string
required

Nome do template.

Example:

"confirmacao_pedido"

language
string
required

Código de idioma.

Example:

"pt_BR"

category
enum<string>
required

Categoria: marketing, utility ou authentication.

Available options:
marketing,
utility,
authentication
variables
object[]
required

Placeholders posicionais do corpo ({{1}}, {{2}}, …).

status
enum<string>
required

Estado de aprovação. Somente approved permite enviar.

Available options:
draft,
submitted,
pending,
approved,
rejected,
paused,
disabled
rejection_reason
enum<string> | null
required

Motivo da rejeição, quando status é rejected.

Available options:
abusive_content,
incorrect_category,
invalid_format,
scam,
tag_content_mismatch,
other
created_at
string<date-time>
required

Quando o template foi criado.

Example:

"2026-09-04T13:22:41.031Z"

updated_at
string<date-time>
required

Quando o template foi atualizado pela última vez.

Example:

"2026-09-04T13:22:41.031Z"

components
object

Cabeçalho, rodapé e botões do template, quando existirem.