Skip to main content
POST
Criar template

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
name
string
obrigatório

Nome único do template (minúsculas, underscores).

Exemplo:

"order_confirmation"

category
string
obrigatório

Categoria do template: AUTHENTICATION, MARKETING ou UTILITY.

Exemplo:

"UTILITY"

language
string
obrigatório

Código de idioma/localidade (ex.: pt_BR, en_US).

Exemplo:

"pt_BR"

components
object[]
obrigatório

Objetos de componente do template (cabeçalho, corpo, rodapé, botões).

Exemplo:
allowCategoryChange
boolean

Permite que a Meta reatribua a categoria durante a revisão.

Exemplo:

true

webhookUrl
string

URL notificada sobre mudanças de status do template.

Exemplo:

"https://example.com/webhooks/template-status"

Resposta

Sucesso — corpo de resposta nativo do provedor.

The persisted template record. Evolution registers the template on the WhatsApp Business (Meta) API and stores the returned metadata locally, returning the saved DB row.

id
string
obrigatório

Internal Evolution record id (cuid).

templateId
string
obrigatório

Meta message template id (HSM id) returned by the WhatsApp Business API.

name
string
obrigatório

Template name.

template
object
obrigatório

Raw response object returned by the Meta message_templates create call.

instanceId
string
obrigatório

Id of the instance that owns the template.

webhookUrl
string | null

Optional webhook URL associated with the template.

createdAt
string<date-time> | null

Creation timestamp.

updatedAt
string<date-time>

Last update timestamp.