Visualizzare in anteprima un modello e-mail

POST /v1/email-templates/{family}/{locale}:preview · permesso email-templates:write · piano Startup e superiori

Renderizza una versione salvata, oppure un contenuto che non hai ancora salvato, con dati di esempio, e restituisce il messaggio completo così come lo vedrebbero i destinatari: il layout della piattaforma, il blocco di sicurezza obbligatorio e il marchio della piattaforma. Non viene salvato né inviato nulla. Il codice e il link di esempio sono casuali a ogni chiamata. La validazione è la stessa del salvataggio di una bozza.

Parametri di percorso

Parametro Descrizione
family Famiglia di e-mail, per esempio verify_email o email_otp (vedi Elencare i modelli e-mail).
locale Tag della lingua, per esempio en o de.

Richiesta

Invia version oppure i campi del contenuto, non entrambi.

Campo Tipo Descrizione
version integer Una versione salvata da renderizzare (1 o maggiore).
subject, html, text_body, from_name string Contenuto non salvato, con le stesse regole di salvataggio di una bozza.

Risposta

200 OK

{
  "subject": "Confirm your email for Example App",
  "html": "<!doctype html><html lang=\"en\">…</html>",
  "text": "Confirm your email: https://login.example.com/preview/9f2c…",
  "locale": "en"
}

locale è la lingua del catalogo usata per le parti proprie della piattaforma.

Errori

HTTP code Quando
400 unknown_field Il corpo contiene un campo sconosciuto o non è un oggetto JSON.
404 not_found La famiglia o la lingua è sconosciuta, oppure la versione non esiste.
403 plan_feature_unavailable Il piano dell'ambiente non include i modelli e-mail personalizzati (Startup e superiori; required_plan indica quale).
413 payload_too_large Il corpo supera i 2 MiB.
422 validation_failed Sono stati inviati sia version sia il contenuto (conflicts_with_content), oppure il contenuto non supera la validazione.
422 template_forbidden_construct Il modello usa un costrutto Liquid fuori dalla sandbox.
401 unauthenticated La credenziale è mancante, non valida o revocata.
403 insufficient_permissions La credenziale non ha il permesso richiesto.
429 rate_limited È stato superato il limite di frequenza; riprova dopo il periodo indicato in Retry-After.
503 service_unavailable Una dipendenza è temporaneamente non disponibile; riprova dopo il periodo indicato in Retry-After.

Esempio

curl -X POST https://api.eu.keenauth.com/v1/email-templates/verify_email/en:preview \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":3}'

CLI: keenauth email-templates preview verify_email en --version 3