Digitalk Developers
  1. WhatsApp oficial
Raiz
  • Raiz
  • CRM
    • CRM — Overview
    • Genérico (data)
      • CRM - Genérico
      • Listar/filtrar registros (qualquer tabela do CRM)
      • Criar/atualizar registros (qualquer tabela do CRM)
      • Hard-delete (não permitido para tabelas company)
    • Empresas Relacionadas
      • CRM - Empresas relacionadas
      • Tipos de relacionamento disponíveis
      • Listar relacionamentos de uma empresa (ambas as direções)
      • Criar relacionamento entre duas empresas
      • Alterar o tipo do relacionamento
      • Inativar relacionamento (reversível)
      • Excluir relacionamento (hard-delete)
    • Ticket ↔ Empresa
      • CRM - Ticket <-> Empresa
      • Empresas elegíveis para o ticket
      • Vincular / trocar a empresa do ticket
    • Templates
      • CRM - Templates
      • Listar templates do tenant (apenas IDs, sem fields)
      • Detalhe completo do template (com fields)
      • Pesquisa formatada por scope (CRMSearchResult)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
      • Criar ticket (básico, com integração CRM opcional)
      • Criar ticket com auto-vínculo / criação de customer via contato
      • Movimentar ticket entre fases (ou finalizar)
      • Atualizar dados do ticket (nome, descrição, valor)
      • Vincular cliente CRM a um ticket existente
      • Adicionar nota ou mensagem ao ticket
    • Workspaces & Workflows
      • Workflow - Workspaces & Workflows
      • Listar workspaces e workflows acessíveis ao usuário
      • Listar fases de um workflow
      • Listar tickets de uma ou mais fases (paginado)
  • Webhooks
    • Eventos
      • Catálogo de eventos disponíveis
      • 📨 [Contrato] Evento entregue na sua URL
    • Assinaturas
      • Listar webhooks cadastrados
      • Criar webhook (o secret aparece UMA única vez)
      • Testar conectividade de uma URL
      • Detalhar webhook
      • Atualizar webhook
      • Ativar/desativar webhook (toggle)
      • Remover webhook (soft delete)
    • Entregas
      • Log de entregas de uma assinatura
      • Reprocessar uma entrega
      • Reprocessar TODAS as entregas com falha
  • Configurações
    • Canais
      • WhatsApp oficial
        • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
        • Listar números disponíveis de uma WABA
        • Criar conexão de WhatsApp oficial
        • Conectar o número oficial (ativar a conexão)
      • Telefonia
        • Anexar gravação de ligação (telefonia de terceiros)
        • Registrar CSAT de ligação
        • Consultar status da gravação enviada
    • Templates
      • WhatsApp oficial
        • Listar templates HSM (a tela Templates › WhatsApp oficial)
          GET
        • Criar template HSM (+ Novo modelo)
          POST
        • Detalhar template
          GET
        • Atualizar template
          PUT
        • Excluir template
          DELETE
        • Sincronizar templates com a Meta
          POST
        • Upload de mídia para o header do template
          POST
      • RCS
        • Listar templates de RCS
    • Base de dados
      • Modelo de colunas do CSV
      • Importar base (CSV) para uma tabela do CRM
      • Acompanhar as importações (validar o resultado)
      • Erros de uma importação
      • Exportar os erros em planilha
  1. WhatsApp oficial

Detalhar template

GET
{{baseURL}}/api/v3/settings/channels-gateway/manager/templates/{id}
Última modificação:2026-08-18 16:40:31
Retorna um template pelo id da plataforma, com o conteúdo completo e,
por padrão, os vínculos (links).
Use pra:
Renderizar o preview do modelo antes do disparo
Conferir as variáveis e a ordem em que devem ser preenchidas
Ver o motivo da reprovação em reason quando o status é rejected
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 de Caminho

Parâmetros de Consulta

Parâmetros Header

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://api-{tenant}.digitalk.com.br/api/v3/settings/channels-gateway/manager/templates/d41a8c76-3b52-4e09-9f18-6c7b204ea351?includeLinks=undefined' \
--header 'api-key: API_TOKEN (disponível no database da plataforma)'

Respostas

🟢200OK
application/json
Template encontrado.
Bodyapplication/json

Exemplo
{
    "id": "f0928d15-6a34-4b7c-8e51-93df20a6b478",
    "name": "boletim_mensal",
    "description": null,
    "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
    "externalId": "600000000000002",
    "appId": "800000000000001",
    "wabaId": "900000000000002",
    "status": "active",
    "channel": "whatsapp",
    "contentType": "hsm",
    "content": {
        "type": "hsm",
        "category": "marketing",
        "language": "pt_BR",
        "components": [
            {
                "type": "header",
                "example": "4::aW1hZ2UvanBlZw==:EXEMPLO_HANDLE_DE_MIDIA_DA_META",
                "subType": "image",
                "fileName": "boletim.jpg"
            },
            {
                "text": "No boletim deste mês reunimos conteúdos estratégicos para apoiar decisões que impactam a sua operação.\n⭐ Acesse agora os destaques.",
                "type": "body"
            },
            {
                "type": "buttons",
                "buttons": [
                    {
                        "url": "https://redirect.digitalk.com.br/r/{{1}}",
                        "text": "Acessar o Boletim",
                        "type": "url",
                        "example": "https://redirect.digitalk.com.br/r/exemplo",
                        "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
                    }
                ]
            }
        ],
        "parameterFormat": "named"
    },
    "variables": [
        {
            "type": "header",
            "default": "https://storage.example.com/ms-channels-gateway/exemplo/media.jpeg",
            "subType": "image"
        },
        {
            "type": "button",
            "index": 0,
            "default": "https://redirect.digitalk.com.br/r/",
            "subType": "url",
            "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
        }
    ],
    "reason": null,
    "analytics": {},
    "activeAt": "2026-07-30T13:23:34.823Z",
    "archivedAt": null,
    "deletedAt": null,
    "inactiveAt": null,
    "inReviewAt": null,
    "rejectedAt": null,
    "flaggedAt": null,
    "pausedAt": null,
    "lockedAt": null,
    "inAppealAt": null,
    "limitExceededAt": null,
    "pendingDeletionAt": null,
    "reinstatedAt": null,
    "createdAt": "2026-07-29T14:11:31.612Z",
    "updatedAt": "2026-07-30T13:23:34.823Z",
    "wabaName": "Marketing"
}
🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
Modificado em 2026-08-18 16:40:31
Página anterior
Criar template HSM (+ Novo modelo)
Próxima página
Atualizar template
Built with