Pular para o conteúdo

Atualizar template

PUT/connections/{id}/templates/{name}

Atualiza o corpo, a mídia ou os dois em um template da conexão. Um campo que não vem no corpo da requisição fica como está; media: null remove a mídia. Escopo necessário: templates:write.

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.

Corpo da requisição

bodystring

Novo texto da mensagem, com variáveis no formato {{nome}}.

mediaobject | null

Nova mídia, a partir de uma URL https pública; null remove a mídia do template.

media.typestringobrigatório

Tipo da mídia: image, video, audio, document ou sticker.

Valores: "image", "video", "audio", "document", "sticker"
media.urlstring · uriobrigatório

URL https pública do arquivo, baixada no momento de cada envio. Uma URL que não é https, que traz usuário e senha ou que aponta para um endereço privado ou interno é recusada já aqui, com 400.

formato `^https://`
media.captionstring

Legenda. Pode usar as mesmas {{variáveis}} do corpo: no envio, elas são substituídas pelos valores de variables, e uma variável que só aparece na legenda e não veio vira texto vazio.

media.fileNamestring

Nome do arquivo, como o destinatário vê.

media.mimetypestring

Tipo MIME do arquivo (por exemplo, application/pdf). Obrigatório quando type é document.

media.pttboolean

Aceito para manter o mesmo formato do envio, mas o template não guarda este campo: o áudio de um template sai como arquivo de áudio, não como mensagem de voz.

media.gifPlaybackboolean

Aceito para manter o mesmo formato do envio, mas o template não guarda este campo: o vídeo de um template sai como vídeo comum.

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200O template atualizado: id, name, body e updatedAt.
400A mídia nova é inválida: a URL da mídia é recusada (Media URL must not carry credentials, Media URL points to a non-public address), ou a mídia é um document sem mimetype (media.mimetype is required for documents). error diz qual foi.
400FST_ERR_VALIDATIONO corpo (por exemplo, media sem type ou sem url, um type fora da lista, ou media.url que não começa com https://) ou o id da conexão 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 templates:write; a mensagem cita o escopo (This credential lacks the templates:write 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

O nome não muda: para renomear, crie um template novo e exclua o antigo.

Uma media nova substitui a anterior inteira: caption, fileName e mimetype que não vierem ficam vazios.

Mudar o corpo muda as variáveis que o envio exige: confira com GET /connections/{id}/templates/{name}.

Guia: Enviar mensagens

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