Criar template HSM (+ Novo modelo)

POST

{{baseURL}}/api/v3/settings/channels-gateway/manager/templates

Última modificação:2026-08-18 16:40:31

Cria um novo modelo e o submete à Meta para aprovação — é o botão
+ Novo modelo da tela.

O template nasce em análise (in-review) e só fica disponível para envio quando a
Meta aprovar (status: "active"). O name precisa seguir as regras da Meta:
minúsculas, números e _, sem espaços.

Use pra:

Cadastrar um HSM novo por API em vez de pela tela

Versionar modelos junto do código da campanha

Header de imagem: faça antes o POST /manager/templates/media e use a URL
retornada. Botões de URL com variável precisam de example preenchido, senão a
Meta rejeita.

Este endpoint também atende RCS. Use channel=rcs e o contentType
correspondente (text, rich-card ou carousel) — o formato do content muda
conforme o tipo. Veja Configurações › Templates › RCS.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples

HSM de texto com variável nomeadaHSM com header de imagem e botão de URL

{
    "name": "continuacao_conversa",
    "channel": "whatsapp",
    "contentType": "hsm",
    "wabaId": "900000000000001",
    "appId": "800000000000001",
    "content": {
        "type": "hsm",
        "category": "marketing",
        "language": "pt_BR",
        "parameterFormat": "named",
        "components": [
            {
                "type": "body",
                "text": "Olá! Meu nome é {{agente}} e vou dar continuidade ao seu atendimento.",
                "variables": [
                    {
                        "parameterName": "agente",
                        "example": "João"
                    }
                ]
            }
        ]
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

HSM de texto com variável nomeadaHSM com header de imagem e botão de URL

curl --location --globoff 'https://api-{tenant}.digitalk.com.br/api/v3/settings/channels-gateway/manager/templates' \
--header 'api-key: API_TOKEN (disponível no database da plataforma)' \
--header 'Content-Type: application/json' \
--data '{
    "name": "continuacao_conversa",
    "channel": "whatsapp",
    "contentType": "hsm",
    "wabaId": "900000000000001",
    "appId": "800000000000001",
    "content": {
        "type": "hsm",
        "category": "marketing",
        "language": "pt_BR",
        "parameterFormat": "named",
        "components": [
            {
                "type": "body",
                "text": "Olá! Meu nome é {{agente}} e vou dar continuidade ao seu atendimento.",
                "variables": [
                    {
                        "parameterName": "agente",
                        "example": "João"
                    }
                ]
            }
        ]
    }
}'

Respostas

🟢201Criado

application/json

Template criado e enviado para análise da Meta.

Bodyapplication/json

Exemplo

{
    "id": "d41a8c76-3b52-4e09-9f18-6c7b204ea351",
    "name": "continuacao_conversa",
    "description": null,
    "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
    "externalId": "600000000000001",
    "appId": "800000000000001",
    "wabaId": "900000000000001",
    "status": "in-review",
    "channel": "whatsapp",
    "contentType": "hsm",
    "content": {
        "type": "hsm",
        "category": "marketing",
        "language": "pt_BR",
        "components": [
            {
                "text": "Olá! Tudo bem?\n\nMeu nome é {{agente}} e faço parte da equipe.\n\nA partir de agora, vou dar continuidade ao seu atendimento.\n\nPodemos continuar a conversa?",
                "type": "body",
                "variables": [
                    {
                        "example": "João",
                        "parameterName": "agente"
                    }
                ]
            }
        ],
        "parameterFormat": "named"
    },
    "variables": [
        {
            "type": "body",
            "default": "João",
            "parameterName": "agente"
        }
    ],
    "reason": null,
    "analytics": {},
    "activeAt": null,
    "archivedAt": null,
    "deletedAt": null,
    "inactiveAt": null,
    "inReviewAt": "2026-08-14T13:41:02.118Z",
    "rejectedAt": null,
    "flaggedAt": null,
    "pausedAt": null,
    "lockedAt": null,
    "inAppealAt": null,
    "limitExceededAt": null,
    "pendingDeletionAt": null,
    "reinstatedAt": null,
    "createdAt": "2026-07-30T20:30:31.938Z",
    "updatedAt": "2026-07-30T20:39:03.406Z",
    "wabaName": "Atendimento Comercial"
}

🟠400Pedido Inválido

🟠401Não Autorizado

🟠403Proibido

Modificado em 2026-08-18 16:40:31

Página anterior

Listar templates HSM (a tela Templates › WhatsApp oficial)

Próxima página

Detalhar template