Skip to main content
POST

Authorizations

Authorization
string
header
required

Chave de API da sua empresa (sk_...). Crie no painel Superlead em Integrações → API e envie em toda chamada como Authorization: Bearer sk_.... Veja Autenticação.

Body

application/json
name
string
required

Nome do template: só minúsculas, números e _, até 512 caracteres. É o valor usado em template.name no envio.

Pattern: ^[a-z0-9_]{1,512}$
Example:

"confirmacao_consulta"

language
string
required

Código do idioma na Meta.

Required string length: 2 - 15
Example:

"pt_BR"

category
enum<string>
required

Categoria pedida. A Meta pode atribuir outra — confira a resposta.

Available options:
MARKETING,
UTILITY,
AUTHENTICATION
Example:

"UTILITY"

components
object[]
required

Componentes do template no formato da Meta (HEADER, BODY, FOOTER, BUTTONS). Cada item precisa de type; o restante segue a documentação da Meta. Em cabeçalho de mídia, example.header_handle[0] aceita uma URL https pública do arquivo de exemplo.

Required array length: 1 - 10 elements
parameter_format
enum<string>

Como as variáveis são escritas: POSITIONAL ({{1}}, padrão) ou NAMED ({{nome}}).

Available options:
POSITIONAL,
NAMED
Example:

"POSITIONAL"

Response

Template criado e enviado para aprovação.

id
string

Id do template (tpl_...). Use nas rotas /v1/whatsapp/templates/{id}.

Example:

"tpl_1689556908129832"

name
string

Nome do template — use como template.name no envio.

Example:

"confirmacao_consulta"

language
string | null

Código do idioma — use como template.language.code no envio.

Example:

"pt_BR"

category
string | null

Categoria atribuída pela Meta (MARKETING, UTILITY, AUTHENTICATION). Pode ser diferente da que você pediu.

Example:

"UTILITY"

status
string

Status na Meta (APPROVED, PENDING, REJECTED, PAUSED, DISABLED, IN_APPEAL, PENDING_DELETION...). Só APPROVED pode ser enviado. Valores novos podem surgir.

Example:

"APPROVED"

parameter_format
string | null

Como as variáveis são escritas: POSITIONAL ({{1}}) ou NAMED ({{nome}}).

Example:

"POSITIONAL"

rejected_reason
string | null

Motivo informado pela Meta quando status é REJECTED; null nos demais casos.

Example:

null

components
object[] | null

Estrutura do template (cabeçalho, corpo, rodapé, botões) no formato da Meta. Em cabeçalho de mídia, o exemplo volta como uma URL temporária da Meta.