Templates

Com a API de templates você pode listar os templates de mensagens disponíveis para envio. Templates são mensagens pré-aprovadas para iniciar conversas ou enviar notificações.

Listar Templates

GET https://api.tinko.com.br/v1/templates

Retorna todos os templates disponíveis para envio de mensagens.

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação. Ex: `Bearer seu_token`

Query Parameters

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Número da página. Default: `1`
per_page	integer	Não	Registros por página (máx: 100). Default: `20`
channel	string	Não	Filtrar por ID do canal. Default: `todos`
status	string	Não	Filtrar por status: `approved`, `pending`, `rejected`. Default: `todos`
category	string	Não	Filtrar por categoria: `marketing`, `utility`, `authentication`. Default: `todos`
search	string	Não	Buscar por nome do template

Exemplo de requisição

curl -X GET "https://api.tinko.com.br/v1/templates?status=approved&category=utility" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

{
  "success": true,
  "data": [
    {
      "id": "01arz3ndektsv4rrffq69g5fav",
      "name": "order_confirmation",
      "language": "pt_BR",
      "category": "utility",
      "status": "approved",
      "components": [
        {
          "type": "header",
          "format": "image"
        },
        {
          "type": "body",
          "text": "Olá {{1}}, seu pedido #{{2}} foi confirmado! Previsão de entrega: {{3}}.",
          "variables": ["nome", "numero_pedido", "data_entrega"]
        },
        {
          "type": "footer",
          "text": "Obrigado por comprar conosco!"
        },
        {
          "type": "buttons",
          "buttons": [
            {
              "type": "url",
              "text": "Rastrear Pedido",
              "url": "https://exemplo.com/rastreio/{{1}}"
            },
            {
              "type": "phone",
              "text": "Ligar para Suporte",
              "phone": "+5511999999999"
            }
          ]
        }
      ],
      "channel": {
        "id": "01hxyz123abc456def789ghjkm",
        "name": "WhatsApp Oficial",
        "type": "whatsapp"
      },
      "created_at": "2025-10-01T10:00:00.000000Z",
      "updated_at": "2025-10-15T14:30:00.000000Z"
    }
  ],
  "pagination": {
    "total": 3,
    "per_page": 20,
    "current_page": 1,
    "last_page": 1
  }
}

Campos do Response

Campo	Tipo	Descrição
id	string	ID do template
name	string	Nome identificador do template (usado no envio)
language	string	Código do idioma: `pt_BR`, `en_US`, `es_ES`
category	string	Categoria: `marketing`, `utility`, `authentication`
status	string	Status: `approved`, `pending`, `rejected`
components	array	Componentes do template (header, body, footer, buttons)
channel	object	Canal vinculado ao template

Componentes

Tipo	Descrição
header	Cabeçalho (texto, imagem, vídeo ou documento)
body	Corpo principal com texto e variáveis
footer	Rodapé (texto simples)
buttons	Botões de ação (URL, telefone ou resposta rápida)

Status

Status	Descrição
approved	Aprovado e disponível para envio
pending	Aguardando aprovação
rejected	Rejeitado (não pode ser enviado)

Categorias

Categoria	Descrição
marketing	Mensagens promocionais, ofertas e campanhas
utility	Mensagens transacionais (confirmações, atualizações)
authentication	Códigos de verificação

Envio de Templates

Para enviar um template, use o endpoint de envio em Mensagens.