Pubblicare un modello e-mail

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

Riconvalida una bozza e la pubblica. La versione pubblicata precedente viene archiviata e il record di audit di gestione email_template.published viene scritto nella stessa transazione. Le e-mail inviate da questo momento usano la nuova versione.

Pubblicare la versione già pubblicata non cambia nulla e la restituisce di nuovo, quindi i tentativi ripetuti sono sicuri. Una bozza più vecchia della versione pubblicata, oppure una versione archiviata, restituisce 409; usa ripristina per tornare a una versione archiviata.

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

Campo Tipo Obbligatorio Descrizione
version integer sì La versione bozza da pubblicare (1 o maggiore).

Risposta

200 OK con la versione pubblicata (status: published).

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).
409 conflict La versione è archiviata o più vecchia della versione pubblicata.
422 validation_failed version manca o è minore di 1, oppure la bozza non supera più la validazione.
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:publish \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"version":3}'

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