Atualizar template
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.
Parâmetros de caminho
idstring · uuidobrigatórioIdentificador da conexão (o número).
namestringobrigatórioNome do template. A busca não diferencia maiúsculas de minúsculas: o nome é guardado e procurado em minúsculas.
Corpo da requisição
bodystringNovo texto da mensagem, com variáveis no formato {{nome}}.
mediaobject | nullNova mídia, a partir de uma URL https pública; null remove a mídia do template.
media.typestringobrigatórioTipo da mídia: image, video, audio, document ou sticker.
"image", "video", "audio", "document", "sticker"media.urlstring · uriobrigatórioURL 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.
media.captionstringLegenda. 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.fileNamestringNome do arquivo, como o destinatário vê.
media.mimetypestringTipo MIME do arquivo (por exemplo, application/pdf). Obrigatório quando type é document.
media.pttbooleanAceito 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.gifPlaybackbooleanAceito 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
| Código | Erro e descrição |
|---|---|
| 200 | O template atualizado: id, name, body e updatedAt. |
| 400 | A 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. |
| 400 | FST_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. |
| 401 | Sem chave de API, ou com uma chave inválida: desconhecida, revogada ou expirada. O corpo é {"error": "Unauthorized"}. |
| 403 | A chave não tem o escopo templates:write; a mensagem cita o escopo (This credential lacks the templates:write scope). |
| 404 | A 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. |
| 404 | A conexão não tem um template com esse nome ({"error": "Template not found"}). |
| 429 | Requisiçõ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