Template ospitati

Ciclo di vita

Un template ha un ID e una chiave stabili, una bozza modificabile, zero o più release pubblicate immutabili e un ciclo di vita attivo o archiviato. L'archiviazione impedisce nuovi invii tramite chiave senza eliminare le release storiche né i dati di utilizzo.

Variabili

Dichiara le variabili con chiave, tipo, obbligatorietà e valore predefinito facoltativo. Il rendering fallisce con 422 quando i dati forniti non rispettano il contratto pubblicato. I valori inseriti vengono sottoposti a escape in base al contesto.

Salvataggio automatico ottimistico

Ogni bozza ha una revisione. Invia la revisione corrente a PUT /templates/:id/draft. Se un altro editor ha salvato prima di te, SendHQ restituisce 409: ricarica prima di sovrascrivere.

Anteprima, test, pubblicazione

1. Esegui il rendering con dati di esempio rappresentativi.
2. Risolvi ogni errore segnalato.
3. Invia uno snapshot di test a un indirizzo che controlli.
4. Pubblica la bozza esatta come release immutabile.

Inviare tramite chiave

{
  "from": "hello@example.com",
  "to": [
    "customer@example.net"
  ],
  "template": {
    "key": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}

Un invio con template personalizzato richiede esattamente un destinatario To e nessun Cc o Bcc. Per destinatari personalizzati usa l'endpoint batch.

Provenienza

Ogni invio da template registra il template, la release, la versione del compilatore e l'hash del contenuto renderizzato, così un messaggio storico può essere ricondotto al contenuto che lo ha prodotto.