Saltar para a documentação
API

Atualizar um modelo

Os metadados são alterados no próprio registo. Mexer no corpo de um modelo publicado cria um novo rascunho.

PATCHapi.openemail.uk/templates/{id}

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

PATCH /templates/{id}

Os metadados são alterados no próprio registo. Mexer no corpo de um modelo publicado cria um novo rascunho.

Exemplo

Requer templates:write. name, description e status são metadados; subject, document, html, slots, props e engine são o corpo, e enviar qualquer um deles é o que cria uma versão.

curl
curl -X PATCH "$OE/templates/order-shipped" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "html": "<p>Hello {{customer}}, {{orderId}} is on its way.</p>",    "expectedVersion": 4  }'
Resposta
{  "object": "template",  "id": "tpl_9c1f0a4b7e05d3862c1f0a44",  "publishedVersion": 3,  "latestVersion": 5,  "latest": { "object": "template_version", "version": 5, "state": "draft", "publishedAt": null }}

O novo rascunho não pode ser enviado e nada em produção mudou: os envios continuam a resolver a versão 3 até publicar. É precisamente por isso que a edição não acontece no próprio registo.

expectedVersion é a versão que leu antes de editar. Se a fornecer, uma edição concorrente dá um 409 version_conflict em vez de uma substituição silenciosa; se a omitir, vence a última escrita, o que está bem para uma pessoa num separador e mal para um script.

status: "archived" retira um modelo da lista sem o apagar. Um modelo arquivado continua a ser resolvido por um envio que o indique. Arquivar é uma arrumação, não um interruptor de emergência.