Skip to content

POST /mailing/send-template ​

Mette in coda una nuova richiesta di email usando un template esistente.

Panoramica ​

Usa questo endpoint per inviare un'email con un template salvato in Mailiqo. La versione del template selezionata per l'invio fornisce l'oggetto, il corpo HTML e il corpo in testo semplice. I destinatari vengono elaborati come in POST /mailing/send.

I segnaposto del template usano la sintassi . Le variabili non presenti vengono sostituite con una stringa vuota, e le variabili che non compaiono nel template vengono ignorate.

Endpoint ​

http
POST /v1/mailing/send-template
bash
curl -X POST https://api.mailiqo.com/v1/mailing/send-template \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
    "from": "[email protected]",
    "to": "[email protected]",
    "variables": {"first_name": "Jane"}
  }'

Corpo della richiesta ​

Il corpo della richiesta va inviato in JSON.

Campi obbligatori ​

CampoTipoObbligatorioDescrizione
template_uuidstringSìUUID del template da usare.
fromstring (email)SìIndirizzo email del mittente.
tomixedSìDestinatari principali. Vedi il formato dei destinatari qui sotto.

Campi facoltativi ​

CampoTipoObbligatorioDescrizione
ccmixedNoDestinatari in copia.
bccmixedNoDestinatari in copia nascosta.
variablesobjectNoValori usati per sostituire i segnaposto del template.
attachmentsarrayNoLista di allegati.
force_validationbooleanNoEsegue un nuovo controllo su ogni destinatario durante l'invio, senza riutilizzare risultati precedenti. Equivale a validation.mode: "always", e spende un credito per destinatario controllato
validationobjectNoRegola la validazione solo per questo invio. Vedi Validazione per questo invio

Validazione per questo invio ​

Funziona esattamente come in POST /mailing/send. Per impostazione predefinita si applica la configurazione del dominio di invio; l'oggetto validation la rende più rigorosa solo per questa richiesta:

json
{
  "template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
  "from": "[email protected]",
  "to": "[email protected]",
  "validation": {
    "mode": "always",
    "level": "restrictive",
    "block": ["catch_all", "risky"]
  }
}
CampoValoriDescrizione
modeunknown_only, alwaysQuando viene sondata la casella del destinatario
levelpreventive, restrictiveQuanto è esigente il controllo
blocklista di catch_all, risky, unknownRisultati dubbi che scarti per questo invio

Un invio può solo rendere più rigoroso

La regolazione non allenta mai la configurazione del dominio, e block si aggiunge soltanto a ciò che il dominio già blocca. Per questo mode non accetta never. Un valore non riconosciuto restituisce 400 con il codice 1419.

La spiegazione completa è in Validazione dei destinatari.

Formato dei destinatari ​

to, cc e bcc usano gli stessi formati documentati in POST /mailing/send.

Formato delle variabili ​

json
{
  "first_name": "Jane",
  "company_name": "Acme"
}

Questi valori possono essere usati da segnaposto come {{first_name}} e {{company_name}}.

Esempio di richiesta ​

json
{
  "template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
  "from": "[email protected]",
  "to": [
    {
      "name": "Jane Doe",
      "email": "[email protected]"
    }
  ],
  "variables": {
    "first_name": "Jane",
    "company_name": "Acme"
  },
  "attachments": [
    {
      "filename": "invoice.pdf",
      "content_base64": "JVBERi0xLjQKJ...",
      "content_type": "application/pdf"
    }
  ]
}

Esempio di risposta riuscita (status = success) ​

json
{
  "status": "success",
  "data": {
    "uuid": "0c4ab8dc-0df4-4ef6-89ea-53ee4a8e1a3f",
    "sent_to": [
      {
        "name": "Jane Doe",
        "email": "[email protected]"
      }
    ],
    "rejected_recipients": []
  }
}

Esempio di risposta di errore ​

json
{
  "status": "error",
  "error": {
    "code": "1416",
    "message": "Email template not found.",
    "details": {}
  }
}

Risposte HTTP ​

StatoSignificato
200Richiesta elaborata.
400Richiesta non valida o errore di validazione.
401Autenticazione fallita o richiesta non autorizzata.
404Template non trovato.
409Il template non ha una versione pubblicata (1420).
429Limite di invio raggiunto (1421). Aspetta i secondi indicati nell'header Retry-After prima di inviare di nuovo. Vedi Limiti di invio.
500Errore interno del server.

Note ​

  • Il template fornisce l'oggetto e il contenuto del corpo.
  • La consegna è asincrona dopo l'accettazione della richiesta.
  • I destinatari accettati e rifiutati seguono lo stesso formato di risposta di POST /mailing/send.

Endpoint correlati ​

Vedi anche ​

Built with VitePress