Reference
All endpoints
Every Emailit API v2 endpoint in one place, grouped by resource, with its HTTP method, path, the API key scope it needs and a link to its reference.
This page lists every endpoint of the Emailit API, grouped by resource. Paths are relative to the base URL https://api.emailit.com/v2, and {id} stands for the ID of the object (or, where the endpoint allows it, its name or email address).
The Scope column shows which API keys can call the endpoint:
| Scope | Works with |
|---|---|
sending |
Keys with the sending or the full scope. |
full |
Keys with the full scope only. |
OAuth access tokens follow the same rules as API keys with the same scope.
Emails
Send email, look up messages and their content, and schedule, cancel, retry or forward them. See Emails for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Send an email | POST |
/emails |
sending |
| List emails | GET |
/emails |
full |
| Retrieve an email | GET |
/emails/{id} |
full |
| Retrieve raw MIME | GET |
/emails/{id}/raw |
full |
| List attachments | GET |
/emails/{id}/attachments |
full |
| Retrieve the body | GET |
/emails/{id}/body |
full |
| Retrieve metadata | GET |
/emails/{id}/meta |
full |
| Update a scheduled email | POST |
/emails/{id} |
sending |
| Cancel an email | POST |
/emails/{id}/cancel |
sending |
| Retry an email | POST |
/emails/{id}/retry |
sending |
| Forward an email | POST |
/emails/{id}/forward |
sending |
| Retrieve status only | GET |
/email/{id} |
full |
Domains
Add sending domains, read their DNS records and verification status, and verify them. See Domains for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a domain | POST |
/domains |
full |
| Retrieve a domain | GET |
/domains/{id} |
full |
| Verify a domain | POST |
/domains/{id}/verify |
full |
| Update a domain | POST |
/domains/{id} |
full |
| List domains | GET |
/domains |
full |
| Delete a domain | DELETE |
/domains/{id} |
full |
DMARC reports
Read aggregate and forensic DMARC reports for a sending domain, or upload your own. See DMARC reports for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| List aggregate reports | GET |
/domains/{id}/dmarc/reports |
full |
| Retrieve a report | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Upload a report | POST |
/domains/{id}/dmarc/reports |
full |
| List forensic reports | GET |
/domains/{id}/dmarc/forensic |
full |
| Retrieve a forensic report | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Retrieve statistics | GET |
/domains/{id}/dmarc/stats |
full |
| List sending sources | GET |
/domains/{id}/dmarc/sources |
full |
| List countries | GET |
/domains/{id}/dmarc/countries |
full |
| List networks (ASNs) | GET |
/domains/{id}/dmarc/asns |
full |
| List reporters | GET |
/domains/{id}/dmarc/reporters |
full |
API keys
Create, list, rename and revoke the API keys of a workspace. See API keys for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create an API key | POST |
/api-keys |
full |
| Retrieve an API key | GET |
/api-keys/{id} |
full |
| List API keys | GET |
/api-keys |
full |
| Update an API key | POST |
/api-keys/{id} |
full |
| Regenerate an API key | POST |
/api-keys/{id}/regenerate |
full |
| Delete an API key | DELETE |
/api-keys/{id} |
full |
Audiences
Manage subscriber lists used by campaigns and sign-up forms. See Audiences for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create an audience | POST |
/audiences |
full |
| Retrieve an audience | GET |
/audiences/{id} |
full |
| Update an audience | POST |
/audiences/{id} |
full |
| List audiences | GET |
/audiences |
full |
| Delete an audience | DELETE |
/audiences/{id} |
full |
Subscribers
Add, update and remove the subscribers of an audience. See Subscribers for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Add a subscriber | POST |
/audiences/{audience_id}/subscribers |
full |
| Retrieve a subscriber | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Update a subscriber | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| List subscribers | GET |
/audiences/{audience_id}/subscribers |
full |
| Delete a subscriber | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Contacts
Manage contact profiles and custom fields, in bulk or one at a time. See Contacts for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a contact | POST |
/contacts |
full |
| Retrieve a contact | GET |
/contacts/{id} |
full |
| Update a contact | POST |
/contacts/{id} |
full |
| List contacts | GET |
/contacts |
full |
| Bulk update contacts | POST |
/contacts/bulk |
full |
| Export contacts | GET, POST |
/contacts/export |
full |
| Delete a contact | DELETE |
/contacts/{id} |
full |
Campaigns
Create campaigns, choose their audiences, and send or schedule them. See Campaigns for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a campaign | POST |
/campaigns |
full |
| Retrieve a campaign | GET |
/campaigns/{id} |
full |
| Update a campaign | POST |
/campaigns/{id} |
full |
| List campaigns | GET |
/campaigns |
full |
| Send or schedule a campaign | POST |
/campaigns/{id}/send |
full |
| Cancel a campaign | POST |
/campaigns/{id}/cancel |
full |
| Delete a campaign | DELETE |
/campaigns/{id} |
full |
Automations
Build workflows from triggers and steps, run them, and inspect their runs. See Automations for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create an automation | POST |
/automations |
full |
| Retrieve an automation | GET |
/automations/{id} |
full |
| Update an automation | POST |
/automations/{id} |
full |
| List automations | GET |
/automations |
full |
| Delete an automation | DELETE |
/automations/{id} |
full |
| Start an automation | POST |
/automations/{id}/start |
full |
| Pause an automation | POST |
/automations/{id}/pause |
full |
| Stop an automation | POST |
/automations/{id}/stop |
full |
| Trigger a run | POST |
/automations/{id}/trigger |
full |
| List runs | GET |
/automations/{id}/runs |
full |
| Retrieve a run | GET |
/automations/{id}/runs/{run_id} |
full |
| Retrieve statistics | GET |
/automations/{id}/stats |
full |
| Retrieve step statistics | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Forms
Create sign-up forms, publish them, and rotate their public token. See Forms for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a form | POST |
/forms |
full |
| Retrieve a form | GET |
/forms/{id} |
full |
| Update a form | POST |
/forms/{id} |
full |
| List forms | GET |
/forms |
full |
| Publish a form | POST |
/forms/{id}/publish |
full |
| Unpublish a form | POST |
/forms/{id}/unpublish |
full |
| Reset the public token | POST |
/forms/{id}/reset-token |
full |
| Delete a form | DELETE |
/forms/{id} |
full |
Templates
Create template versions, publish one per alias, and use them when sending. See Templates for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a template | POST |
/templates |
full |
| Retrieve a template | GET |
/templates/{id} |
full |
| Update a template | POST |
/templates/{id} |
full |
| List templates | GET |
/templates |
full |
| Publish a template | POST |
/templates/{id}/publish |
full |
| Delete a template | DELETE |
/templates/{id} |
full |
Suppressions
Read and manage the addresses Emailit will not send to. See Suppressions for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a suppression | POST |
/suppressions |
full |
| Retrieve a suppression | GET |
/suppressions/{id} |
full |
| Update a suppression | POST |
/suppressions/{id} |
full |
| List suppressions | GET |
/suppressions |
full |
| Delete a suppression | DELETE |
/suppressions/{id} |
full |
Webhooks
Register endpoints that receive signed event notifications. See Webhooks for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a webhook | POST |
/webhooks |
full |
| Retrieve a webhook | GET |
/webhooks/{id} |
full |
| Update a webhook | POST |
/webhooks/{id} |
full |
| List webhooks | GET |
/webhooks |
full |
| Delete a webhook | DELETE |
/webhooks/{id} |
full |
| Send a test event | POST |
/webhooks/{id}/test |
full |
| Rotate the signing secret | POST |
/webhooks/{id}/reset-secret |
full |
| Retry failed requests | POST |
/webhooks/{id}/retry-failed |
full |
| Retry one request | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Events
Read the event stream behind webhooks: deliveries, bounces, opens and more. See Events for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| List events | GET |
/events |
full |
| Retrieve an event | GET |
/events/{id} |
full |
Email verification
Verify a single address in real time. See Email verification for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Verify an address | POST |
/email-verifications |
full |
Verification lists
Verify up to 10,000 addresses at once and export the results. See Verification lists for the full reference.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Create a list | POST |
/email-verification-lists |
full |
| List lists | GET |
/email-verification-lists |
full |
| Retrieve a list | GET |
/email-verification-lists/{id} |
full |
| List results | GET |
/email-verification-lists/{id}/results |
full |
| Export results | GET |
/email-verification-lists/{id}/export |
full |