Riferimento
Tutti gli endpoint
Tutti gli endpoint dell’API v2 di Emailit in un unico posto, raggruppati per risorsa, con metodo HTTP, percorso, il permesso della chiave API che richiedono e un link al riferimento.
Questa pagina elenca tutti gli endpoint dell’API di Emailit, raggruppati per risorsa. I percorsi sono relativi all’URL di base https://api.emailit.com/v2, e {id} indica l’ID dell’oggetto (oppure, dove l’endpoint lo consente, il suo nome o il suo indirizzo email).
La colonna Permesso indica quali chiavi API possono chiamare l’endpoint:
| Permesso | Funziona con |
|---|---|
sending |
Chiavi con il permesso sending o full. |
full |
Solo chiavi con il permesso full. |
I token di accesso OAuth seguono le stesse regole delle chiavi API con lo stesso permesso.
Invia email, consulta i messaggi e il loro contenuto, e programmali, annullali, ritentali o inoltrali. Per il riferimento completo, vedi Email.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Invia un’email | POST |
/emails |
sending |
| Elenca le email | GET |
/emails |
full |
| Recupera un’email | GET |
/emails/{id} |
full |
| Recupera il MIME grezzo | GET |
/emails/{id}/raw |
full |
| Elenca gli allegati | GET |
/emails/{id}/attachments |
full |
| Recupera il corpo | GET |
/emails/{id}/body |
full |
| Recupera i metadati | GET |
/emails/{id}/meta |
full |
| Aggiorna un’email programmata | POST |
/emails/{id} |
sending |
| Annulla un’email | POST |
/emails/{id}/cancel |
sending |
| Ritenta un’email | POST |
/emails/{id}/retry |
sending |
| Inoltra un’email | POST |
/emails/{id}/forward |
sending |
| Recupera solo lo stato | GET |
/email/{id} |
full |
Domini
Aggiungi domini di invio, leggi i loro record DNS e lo stato della verifica, e verificali. Per il riferimento completo, vedi Domini.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un dominio | POST |
/domains |
full |
| Recupera un dominio | GET |
/domains/{id} |
full |
| Verifica un dominio | POST |
/domains/{id}/verify |
full |
| Aggiorna un dominio | POST |
/domains/{id} |
full |
| Elenca i domini | GET |
/domains |
full |
| Elimina un dominio | DELETE |
/domains/{id} |
full |
Report DMARC
Leggi i report DMARC aggregati e forensi di un dominio di invio, o carica i tuoi. Per il riferimento completo, vedi Report DMARC.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Elenca i report aggregati | GET |
/domains/{id}/dmarc/reports |
full |
| Recupera un report | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Carica un report | POST |
/domains/{id}/dmarc/reports |
full |
| Elenca i report forensi | GET |
/domains/{id}/dmarc/forensic |
full |
| Recupera un report forense | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Recupera le statistiche | GET |
/domains/{id}/dmarc/stats |
full |
| Elenca le sorgenti di invio | GET |
/domains/{id}/dmarc/sources |
full |
| Elenca i paesi | GET |
/domains/{id}/dmarc/countries |
full |
| Elenca le reti (ASN) | GET |
/domains/{id}/dmarc/asns |
full |
| Elenca i mittenti dei report | GET |
/domains/{id}/dmarc/reporters |
full |
Chiavi API
Crea, elenca, rinomina e revoca le chiavi API di un workspace. Per il riferimento completo, vedi Chiavi API.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea una chiave API | POST |
/api-keys |
full |
| Recupera una chiave API | GET |
/api-keys/{id} |
full |
| Elenca le chiavi API | GET |
/api-keys |
full |
| Aggiorna una chiave API | POST |
/api-keys/{id} |
full |
| Rigenera una chiave API | POST |
/api-keys/{id}/regenerate |
full |
| Elimina una chiave API | DELETE |
/api-keys/{id} |
full |
Liste
Gestisci le liste di iscritti usate dalle campagne e dai moduli di iscrizione. Per il riferimento completo, vedi Liste.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea una lista | POST |
/audiences |
full |
| Recupera una lista | GET |
/audiences/{id} |
full |
| Aggiorna una lista | POST |
/audiences/{id} |
full |
| Elenca le liste | GET |
/audiences |
full |
| Elimina una lista | DELETE |
/audiences/{id} |
full |
Iscritti
Aggiungi, aggiorna e rimuovi gli iscritti di una lista. Per il riferimento completo, vedi Iscritti.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Aggiungi un iscritto | POST |
/audiences/{audience_id}/subscribers |
full |
| Recupera un iscritto | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Aggiorna un iscritto | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Elenca gli iscritti | GET |
/audiences/{audience_id}/subscribers |
full |
| Elimina un iscritto | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Contatti
Gestisci i profili dei contatti e i campi personalizzati, in blocco o uno alla volta. Per il riferimento completo, vedi Contatti.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un contatto | POST |
/contacts |
full |
| Recupera un contatto | GET |
/contacts/{id} |
full |
| Aggiorna un contatto | POST |
/contacts/{id} |
full |
| Elenca i contatti | GET |
/contacts |
full |
| Aggiorna i contatti in blocco | POST |
/contacts/bulk |
full |
| Esporta i contatti | GET, POST |
/contacts/export |
full |
| Elimina un contatto | DELETE |
/contacts/{id} |
full |
Campagne
Crea campagne, scegli le loro liste e inviale o programmale. Per il riferimento completo, vedi Campagne.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea una campagna | POST |
/campaigns |
full |
| Recupera una campagna | GET |
/campaigns/{id} |
full |
| Aggiorna una campagna | POST |
/campaigns/{id} |
full |
| Elenca le campagne | GET |
/campaigns |
full |
| Invia o programma una campagna | POST |
/campaigns/{id}/send |
full |
| Annulla una campagna | POST |
/campaigns/{id}/cancel |
full |
| Elimina una campagna | DELETE |
/campaigns/{id} |
full |
Automazioni
Costruisci flussi di lavoro con trigger e passaggi, eseguili e analizza le loro esecuzioni. Per il riferimento completo, vedi Automazioni.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un’automazione | POST |
/automations |
full |
| Recupera un’automazione | GET |
/automations/{id} |
full |
| Aggiorna un’automazione | POST |
/automations/{id} |
full |
| Elenca le automazioni | GET |
/automations |
full |
| Elimina un’automazione | DELETE |
/automations/{id} |
full |
| Avvia un’automazione | POST |
/automations/{id}/start |
full |
| Metti in pausa un’automazione | POST |
/automations/{id}/pause |
full |
| Interrompi un’automazione | POST |
/automations/{id}/stop |
full |
| Avvia un’esecuzione | POST |
/automations/{id}/trigger |
full |
| Elenca le esecuzioni | GET |
/automations/{id}/runs |
full |
| Recupera un’esecuzione | GET |
/automations/{id}/runs/{run_id} |
full |
| Recupera le statistiche | GET |
/automations/{id}/stats |
full |
| Recupera le statistiche dei passaggi | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Moduli
Crea moduli di iscrizione, pubblicali e ruota il loro token pubblico. Per il riferimento completo, vedi Moduli.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un modulo | POST |
/forms |
full |
| Recupera un modulo | GET |
/forms/{id} |
full |
| Aggiorna un modulo | POST |
/forms/{id} |
full |
| Elenca i moduli | GET |
/forms |
full |
| Pubblica un modulo | POST |
/forms/{id}/publish |
full |
| Ritira un modulo | POST |
/forms/{id}/unpublish |
full |
| Reimposta il token pubblico | POST |
/forms/{id}/reset-token |
full |
| Elimina un modulo | DELETE |
/forms/{id} |
full |
Template
Crea versioni dei template, pubblicane una per alias e usale per inviare. Per il riferimento completo, vedi Template.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un template | POST |
/templates |
full |
| Recupera un template | GET |
/templates/{id} |
full |
| Aggiorna un template | POST |
/templates/{id} |
full |
| Elenca i template | GET |
/templates |
full |
| Pubblica un template | POST |
/templates/{id}/publish |
full |
| Elimina un template | DELETE |
/templates/{id} |
full |
Soppressioni
Leggi e gestisci gli indirizzi a cui Emailit non invia. Per il riferimento completo, vedi Soppressioni.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea una soppressione | POST |
/suppressions |
full |
| Recupera una soppressione | GET |
/suppressions/{id} |
full |
| Aggiorna una soppressione | POST |
/suppressions/{id} |
full |
| Elenca le soppressioni | GET |
/suppressions |
full |
| Elimina una soppressione | DELETE |
/suppressions/{id} |
full |
Webhook
Registra endpoint che ricevono notifiche di eventi firmate. Per il riferimento completo, vedi Webhook.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea un webhook | POST |
/webhooks |
full |
| Recupera un webhook | GET |
/webhooks/{id} |
full |
| Aggiorna un webhook | POST |
/webhooks/{id} |
full |
| Elenca i webhook | GET |
/webhooks |
full |
| Elimina un webhook | DELETE |
/webhooks/{id} |
full |
| Invia un evento di test | POST |
/webhooks/{id}/test |
full |
| Ruota il secret di firma | POST |
/webhooks/{id}/reset-secret |
full |
| Ritenta le richieste non riuscite | POST |
/webhooks/{id}/retry-failed |
full |
| Ritenta una richiesta | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Eventi
Leggi il flusso di eventi alla base dei webhook: consegne, bounce, aperture e altro. Per il riferimento completo, vedi Eventi.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Elenca gli eventi | GET |
/events |
full |
| Recupera un evento | GET |
/events/{id} |
full |
Verifica email
Verifica un singolo indirizzo in tempo reale. Per il riferimento completo, vedi Verifica email.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Verifica un indirizzo | POST |
/email-verifications |
full |
Liste di verifica
Verifica fino a 10.000 indirizzi alla volta ed esporta gli esiti. Per il riferimento completo, vedi Liste di verifica.
| Endpoint | Metodo | Percorso | Permesso |
|---|---|---|---|
| Crea una lista | POST |
/email-verification-lists |
full |
| Elenca le liste | GET |
/email-verification-lists |
full |
| Recupera una lista | GET |
/email-verification-lists/{id} |
full |
| Elenca gli esiti | GET |
/email-verification-lists/{id}/results |
full |
| Esporta gli esiti | GET |
/email-verification-lists/{id}/export |
full |