Pular para o conteúdo

Consultar template

GET/connections/{id}/templates/{name}

Consulta um template da conexão pelo nome e lista as variáveis que o corpo dele usa: são os valores que o envio precisa receber em variables. Escopo necessário: connections:read.

Ver em Markdown

Parâmetros de caminho

idstring · uuidobrigatório

Identificador da conexão (o número).

namestringobrigatório

Nome do template. A busca não diferencia maiúsculas de minúsculas: o nome é guardado e procurado em minúsculas.

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200O template (id, connectionId, name, body, createdAt e updatedAt) e variables, a lista de variáveis do corpo, cada uma com name e required.
400FST_ERR_VALIDATIONO id da conexão (que precisa ser um UUID) não segue o schema da operação; message diz o que está errado.
401Sem chave de API, ou com uma chave inválida: desconhecida, revogada ou expirada. O corpo é {"error": "Unauthorized"}.
403A chave não tem o escopo connections:read; a mensagem cita o escopo (This credential lacks the connections:read scope).
404A conexão não existe ou não é de quem chama (Connection not found): o recurso de outra pessoa responde exatamente como um que não existe.
404A conexão não tem um template com esse nome ({"error": "Template not found"}).
429Requisições demais deste IP de origem (por padrão, 600 por minuto), ou autenticações com falha demais (por padrão, 20 a cada 5 minutos): espere os segundos de Retry-After. Veja Limites.Cabeçalho: Retry-After

Detalhes

variables traz cada variável do corpo uma vez, na ordem em que aparece, e todas com required: true. As variáveis que só aparecem na legenda da mídia não entram na lista.

Esta resposta não traz a mídia do template; para vê-la, use GET /connections/{id}/templates.

Guia: Enviar mensagens

Esta página ajudou? · Atualizado em 28 set 2026