Detalhar template

GET

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

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

Respostas

🟢200OK

application/json

Template encontrado.

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v3/settings/channels-gateway/manager/templates/d41a8c76-3b52-4e09-9f18-6c7b204ea351?includeLinks=undefined' \
--header 'api-key: {{api-key}}'

Response Example

200 - HSM com header de imagem e botão

{
    "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://links.suaempresa.com.br/r/{{1}}",
                        "text": "Acessar o Boletim",
                        "type": "url",
                        "example": "https://links.suaempresa.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://links.suaempresa.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"
}

Modificado em 2026-11-04 02:53:16

Página anterior

Criar template HSM (+ Novo modelo)

Próxima página

Atualizar template