Pré-visualizar um modelo
Exatamente o HTML que um envio produziria, sem o enviar.
Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.
POST /templates/{id}/preview
Exatamente o HTML que um envio produziria, sem o enviar.
Exemplo
Requer templates:read. É um POST porque os valores vão num corpo; nada é escrito e nada é enviado.
curl -X POST "$OE/templates/order-shipped/preview" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "version": 5, "props": { "orderId": "AC-4192" } }'{ "object": "template_preview", "templateId": "tpl_9c1f0a4b7e05d3862c1f0a44", "version": 5, "subject": "Order AC-4192 is on its way", "html": "<!DOCTYPE html><html>…</html>", "text": "Hello there, AC-4192 is on its way.", "warnings": [{ "code": "unfilled_placeholder", "key": "customer" }]}Aponte a sua CI para aqui. Uma alteração de modelo que parta a sua integração passa então a ser um teste a falhar, em vez de um email confuso para um cliente.
Tolerante onde um envio é rigoroso: uma prop obrigatória em falta é reportada em warnings em vez de recusada, porque um modelo que está a ser pré-visualizado é normalmente um modelo que está a ser escrito. Uma prop DESCONHECIDA continua a dar 422 aqui, porque um erro de digitação é um erro de digitação em qualquer fase.
Um rascunho pode ser pré-visualizado, e este é o único caminho que renderiza alguma coisa fora da publicação. Omita version e pré-visualiza o que está publicado; indique uma para pré-visualizar essa revisão, incluindo rascunhos.
JSON, nunca text/html. O HTML é uma string num campo, para que um cliente possa analisar a resposta antes de decidir o que fazer com ela.