Prévia e teste
Vê o e-mail renderizado com dados de exemplo e envia um teste ao próprio administrador.
Prévia do modelo
Preenche as variáveis do modelo com dados de exemplo (cliente "Maria", loja de exemplo) e devolve o assunto e o HTML finais, já dentro do cabeçalho e rodapé da loja. Nada é gravado nem enviado. Você pode mandar um rascunho de subject e body_html para testar uma edição antes de salvar.
/api/v1/admin/email-templates/{id}/previewAdminMostra como o e-mail ficaria, com dados de exemplo
Rota ligada ao módulo email-notifications: com o módulo desligado a resposta é 403. Leitura e prévia exigem permissão de e-mail (view_email); alterar, restaurar e enviar teste exigem manage_email ou manage_settings.
Parâmetros de caminho
iduuidobrigatórioCorpo da requisição
subjectstringbody_htmlstringExemplo de requisição (Prévia)
curl -X POST "$BASE_URL/api/v1/admin/email-templates/dfd62617-b4fe-40e0-8e16-82debd20fcc0/preview" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"subject": "Olá {{first_name}}, seu carrinho espera",
"body_html": "<p>Oi {{first_name}}</p>"
}'Resposta (Prévia)
{
"subject": "Olá Maria, seu carrinho espera",
"html": "<!DOCTYPE html><html lang=\"pt-BR\">...<p>Oi Maria</p>...</html>"
}Campos da resposta
subjectstringhtmlstringErros (Prévia)
| Status | Quando | Exemplo de corpo |
|---|---|---|
| 401 | Token ausente, inválido ou expirado. | {"error":"invalid or expired token"} |
| 403 | O administrador não tem o privilégio exigido. | {"error":"insufficient privileges","privilege_required_any":["manage_settings","view_email","manage_email","view_sms","manage_sms"]} |
| 404 | Não existe modelo com esse id (também vale para um id que não é UUID). | {"detail":"email template not found: 00000000-0000-0000-0000-000000000000","error":"email template not found"} |
| 500 | Falha ao montar a prévia. | {"error":"failed to preview email template","detail":"..."} |
Enviar e-mail de teste
Envia de verdade um e-mail para o endereço do administrador dono do token, usando o modelo salvo e dados de exemplo. O assunto leva o prefixo [TEST]. Serve para ver como o e-mail chega numa caixa de entrada real. Não precisa de corpo e não aceita outro destinatário.
/api/v1/admin/email-templates/{id}/testAdminEnvia o modelo, com dados de exemplo, para o e-mail do administrador
Rota ligada ao módulo email-notifications: com o módulo desligado a resposta é 403. Leitura e prévia exigem permissão de e-mail (view_email); alterar, restaurar e enviar teste exigem manage_email ou manage_settings.
Parâmetros de caminho
iduuidobrigatórioExemplo de requisição (Enviar teste)
curl -X POST "$BASE_URL/api/v1/admin/email-templates/dfd62617-b4fe-40e0-8e16-82debd20fcc0/test" \
-H "Authorization: Bearer $TOKEN"Resposta (Enviar teste)
{
"status": "sent",
"to": "admin@minhaloja.com.br"
}Campos da resposta
statusstringsent.tostringErros (Enviar teste)
| Status | Quando | Exemplo de corpo |
|---|---|---|
| 401 | Token ausente, inválido ou expirado. | {"error":"invalid or expired token"} |
| 403 | O administrador não tem o privilégio exigido. | {"error":"insufficient privileges","privilege_required_any":["manage_email","manage_settings"]} |
| 404 | Não existe modelo com esse id. | {"error":"email template not found","detail":"get template: email template not found: ..."} |
| 500 | O provedor de e-mail recusou ou não está configurado. | {"error":"failed to send test email","detail":"..."} |