Skip to main content
POST
Criar um modelo

Autorizações

Authorization
string
header
obrigatório

HTTP Basic onde o usuário é o e-mail da conta e a senha é o token de segurança.

Corpo

sender_id
integer
obrigatório
name
string
obrigatório

Normalizado no servidor (minúsculas, espaços viram underscores, caracteres inválidos e dígitos iniciais removidos) e prefixado com user{id}_. A resposta retorna o name final e seu texto original em display_name.

body_text
string
obrigatório

Pode conter os marcadores {{1}}, {{2}}. Um rodapé de identificação do remetente é adicionado automaticamente, incluindo as variáveis reservadas {{sender_name}}, {{sender_doc}} e {{sender_phone}} (substituídas no envio).

category
enum<string>
padrão:UTILITY
Opções disponíveis:
UTILITY,
MARKETING,
AUTHENTICATION
language
string
padrão:pt_BR
header_text
string
header_format
enum<string>
padrão:NONE
Opções disponíveis:
NONE,
TEXT,
IMAGE,
DOCUMENT
header_media
file

Para cabeçalhos IMAGE/DOCUMENT. Sem mídia enviada, um arquivo de exemplo padrão da Escrybe é submetido à Meta para aprovação.

header_media_base64
string
header_media_url
string
header_media_filename
string
variable_examples
string[]

Exemplos para aprovação na Meta. Preenchidos a partir do seu perfil quando omitidos.

Resposta

Criado e enviado para aprovação (o campo code do envelope indica 201)

Envelope usado pelos endpoints de modelos de WhatsApp e pela sincronização de modelos.

code
integer
Exemplo:

200

status
string
Exemplo:

"success"

message
string | null
data
object
request_id
string