Envello
Docs

API reference

Generated from the API's own route schemas, so it can't drift from what the server accepts. The raw spec is at /openapi.json.

Base URL and auth

https://api.envello.dev
Authorization: Bearer env_live_...

Errors return JSON with an error code. Each code has its own entry in the error reference.

Which key

Any key
Works with every key, including sending-only and test-mode keys.
Full-access key
Needs a full-access key. Test-mode keys are fine.
Full-access live key
Needs a full-access live-mode key. These endpoints act on resources shared by test and live mode.
Sandbox key
For AI agents and setup scripts. Test mode only, so nothing is delivered and no webhooks fire. It can send, create and read templates, and read domains. Endpoints marked "or sandbox key" accept it.

Emails

GET /broadcast/settingsFull-access live key

Whether the broadcast stream is on, paused, or unavailable for this account.

GET /emailsFull-access key

List sent emails, newest first.

Query parameters

FieldTypeNotes
status"queued" | "scheduled" | "sent" | "send_error" | "canceled"
tag_namestringlength 1 to 256
tag_valuestringlength 1 to 256
fromstring (date-time)
tostring (date-time)
beforestring (uuid)
limitinteger1 to 100, default 20

Response 200

FieldTypeNotes
datarequiredobject[]
data[].created_atrequiredstring (date-time)
data[].errorrequiredstring | null
data[].idrequiredstring (uuid)
data[].send_atrequiredstring (date-time) or null
data[].sent_atrequiredstring (date-time) or null
data[].statusrequired"queued" | "scheduled" | "sent" | "send_error" | "canceled"
data[].subjectrequiredstring
data[].tagsrequiredobject[]
data[].tags[].namerequiredstringlength 1 to 256
data[].tags[].valuerequiredstringlength 1 to 256
data[].torequiredstring[]
has_morerequiredboolean
next_beforerequiredstring (uuid) or null

POST /emailsAny key or sandbox key

Send one email.

Request body

FieldTypeNotes
attachmentsobject[]0 to 10 items
bccstring or string[]length 3 to 320, 1 to 50 items
ccstring or string[]length 3 to 320, 1 to 50 items
fromrequiredstringlength 3 to 320
headersobjectUp to 50 custom headers. Any X- header except X-SES-* and X-Mailgun-*, plus List-*, In-Reply-To, References, Precedence, Auto-Submitted, Importance, Priority, Keywords, Comments and Feedback-ID. Anything else is a 400.
htmlstring
reply_tostringlength 3 to 320
send_atstring (date-time)
stream"transactional" | "broadcast"
subjectstringlength 1 to 998
tagsobject[]0 to 10 items
tags[].namerequiredstringlength 1 to 256
tags[].valuerequiredstringlength 1 to 256
template_idstring (uuid)
textstring
torequiredstring or string[]length 3 to 320, 1 to 50 items
variablesobject

Response 202

FieldTypeNotes
idrequiredstring (uuid)
statusrequired"queued" | "scheduled" | "sent" | "send_error" | "canceled"

POST /emails/batchAny key or sandbox key

Send up to 100 emails in one request. Failures are reported per item.

Request body

FieldTypeNotes
emailsrequiredobject[]1 to 100 items
emails[].attachmentsobject[]0 to 10 items
emails[].bccstring or string[]length 3 to 320, 1 to 50 items
emails[].ccstring or string[]length 3 to 320, 1 to 50 items
emails[].fromrequiredstringlength 3 to 320
emails[].headersobjectUp to 50 custom headers. Any X- header except X-SES-* and X-Mailgun-*, plus List-*, In-Reply-To, References, Precedence, Auto-Submitted, Importance, Priority, Keywords, Comments and Feedback-ID. Anything else is a 400.
emails[].htmlstring
emails[].reply_tostringlength 3 to 320
emails[].send_atstring (date-time)
emails[].stream"transactional" | "broadcast"
emails[].subjectstringlength 1 to 998
emails[].tagsobject[]0 to 10 items
emails[].tags[].namerequiredstringlength 1 to 256
emails[].tags[].valuerequiredstringlength 1 to 256
emails[].template_idstring (uuid)
emails[].textstring
emails[].torequiredstring or string[]length 3 to 320, 1 to 50 items
emails[].variablesobject

Response 207

FieldTypeNotes
resultsrequiredobject[]

POST /emails/validateAny key or sandbox key

Check an address for syntax, MX records and disposable domains without sending.

Request body

FieldTypeNotes
emailrequiredstringlength 3 to 320

Response 200

FieldTypeNotes
disposablerequiredboolean
emailrequiredstring
mx_foundrequiredboolean
reasonstring
role_accountrequiredboolean
syntax_validrequiredboolean
validrequiredboolean

GET /emails/{id}Any key or sandbox key

Fetch one email and its delivery status.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Response 200

FieldTypeNotes
created_atrequiredstring (date-time)
errorrequiredstring | null
idrequiredstring (uuid)
send_atrequiredstring (date-time) or null
sent_atrequiredstring (date-time) or null
statusrequired"queued" | "scheduled" | "sent" | "send_error" | "canceled"
subjectrequiredstring
tagsrequiredobject[]
tags[].namerequiredstringlength 1 to 256
tags[].valuerequiredstringlength 1 to 256
torequiredstring[]

PATCH /emails/{id}Full-access key

Reschedule a scheduled email.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Request body

FieldTypeNotes
send_atrequiredstring (date-time)

Response 200

FieldTypeNotes
idrequiredstring (uuid)
send_atrequiredstring (date-time)
statusrequired"queued" | "scheduled" | "sent" | "send_error" | "canceled"

DELETE /emails/{id}Any key or sandbox key

Cancel a scheduled email before it sends.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Response 200

FieldTypeNotes
idrequiredstring (uuid)
statusrequired"canceled"

GET /emails/{id}/insightsFull-access key

Deliverability hints for one sent email.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

POST /emails/{id}/shareFull-access key

Create a read-only share link for one email.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Request body

FieldTypeNotes
expires_in_hoursinteger1 to 720, default 168

Response 201

FieldTypeNotes
expires_atrequiredstring (date-time)
urlrequiredstring

Templates

POST /templatesFull-access key or sandbox key

Create a template (version 1).

GET /templates/{id}Full-access key or sandbox key

Fetch a template's current version.

Path parameters

FieldTypeNotes
idrequiredstring

PUT /templates/{id}Full-access key

Update a template. Creates a new version.

Path parameters

FieldTypeNotes
idrequiredstring

DELETE /templates/{id}Full-access key

Delete a template and its version history.

Path parameters

FieldTypeNotes
idrequiredstring

Domains

GET /domainsFull-access live key or sandbox key

List sending domains.

Response 200

FieldTypeNotes
domainsrequiredobject[]
domains[].blocklistStatusobject
domains[].blocklistStatus.checkedAtrequiredstring (date-time) or null
domains[].blocklistStatus.listedrequiredboolean
domains[].blocklistStatus.listedOnrequiredstring[]
domains[].dmarcrequiredobject
domains[].dmarc.notesrequiredstring[]
domains[].dmarc.recordrequiredobject
domains[].dnsRecordsrequiredobject[]
domains[].dnsRecords[].hostrequiredstring
domains[].dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
domains[].dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
domains[].dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
domains[].dnsRecords[].valuerequiredstring
domains[].dnsRecords[].verifiedrequiredboolean
domains[].domainrequiredobject
domains[].domain.accountIdrequiredstring (uuid)
domains[].domain.createdAtrequiredstring (date-time)
domains[].domain.dkimSelectorrequiredstring
domains[].domain.dkimVerifiedAtrequiredstring (date-time) or null
domains[].domain.domainrequiredstringlength 3 to 253
domains[].domain.idrequiredstring (uuid)
domains[].domain.lastCheckedAtrequiredstring (date-time) or null
domains[].domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domains[].domain.returnPathVerifiedAtrequiredstring (date-time) or null
domains[].domain.sendingSubdomainrequiredstringlength 3 to 253
domains[].domain.spfVerifiedAtrequiredstring (date-time) or null
domains[].domain.statusrequired"pending" | "verified" | "failed"
domains[].domain.updatedAtrequiredstring (date-time)
limitrequiredinteger-9007199254740991 to 9007199254740991

POST /domainsFull-access live key

Add a sending domain and get its DNS records.

Request body

FieldTypeNotes
domainrequiredstringlength 3 to 253
returnPathSubdomainstringlength 3 to 253
sendingSubdomainstringlength 3 to 253

Response 201

FieldTypeNotes
blocklistStatusobject
blocklistStatus.checkedAtrequiredstring (date-time) or null
blocklistStatus.listedrequiredboolean
blocklistStatus.listedOnrequiredstring[]
dmarcrequiredobject
dmarc.notesrequiredstring[]
dmarc.recordrequiredobject
dmarc.record.hostrequiredstring
dmarc.record.priorityinteger-9007199254740991 to 9007199254740991
dmarc.record.purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dmarc.record.typerequired"CNAME" | "TXT" | "MX"
dmarc.record.valuerequiredstring
dnsRecordsrequiredobject[]
dnsRecords[].hostrequiredstring
dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
dnsRecords[].valuerequiredstring
dnsRecords[].verifiedrequiredboolean
domainrequiredobject
domain.accountIdrequiredstring (uuid)
domain.createdAtrequiredstring (date-time)
domain.dkimSelectorrequiredstring
domain.dkimVerifiedAtrequiredstring (date-time) or null
domain.domainrequiredstringlength 3 to 253
domain.idrequiredstring (uuid)
domain.lastCheckedAtrequiredstring (date-time) or null
domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domain.returnPathVerifiedAtrequiredstring (date-time) or null
domain.sendingSubdomainrequiredstringlength 3 to 253
domain.spfVerifiedAtrequiredstring (date-time) or null
domain.statusrequired"pending" | "verified" | "failed"
domain.updatedAtrequiredstring (date-time)

POST /domains/claimFull-access live key

Start claiming a domain another account registered.

Request body

FieldTypeNotes
domainrequiredstringlength 3 to 253

Response 200

FieldTypeNotes
domainrequiredstring
txtNamerequiredstring
txtValuerequiredstring

POST /domains/claim/verifyFull-access live key

Finish a domain claim once the TXT record is live.

Request body

FieldTypeNotes
domainrequiredstringlength 3 to 253

GET /domains/{id}Full-access live key or sandbox key

Fetch one domain and its DNS record status.

Path parameters

FieldTypeNotes
idrequiredstring

Response 200

FieldTypeNotes
blocklistStatusobject
blocklistStatus.checkedAtrequiredstring (date-time) or null
blocklistStatus.listedrequiredboolean
blocklistStatus.listedOnrequiredstring[]
dmarcrequiredobject
dmarc.notesrequiredstring[]
dmarc.recordrequiredobject
dmarc.record.hostrequiredstring
dmarc.record.priorityinteger-9007199254740991 to 9007199254740991
dmarc.record.purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dmarc.record.typerequired"CNAME" | "TXT" | "MX"
dmarc.record.valuerequiredstring
dnsRecordsrequiredobject[]
dnsRecords[].hostrequiredstring
dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
dnsRecords[].valuerequiredstring
dnsRecords[].verifiedrequiredboolean
domainrequiredobject
domain.accountIdrequiredstring (uuid)
domain.createdAtrequiredstring (date-time)
domain.dkimSelectorrequiredstring
domain.dkimVerifiedAtrequiredstring (date-time) or null
domain.domainrequiredstringlength 3 to 253
domain.idrequiredstring (uuid)
domain.lastCheckedAtrequiredstring (date-time) or null
domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domain.returnPathVerifiedAtrequiredstring (date-time) or null
domain.sendingSubdomainrequiredstringlength 3 to 253
domain.spfVerifiedAtrequiredstring (date-time) or null
domain.statusrequired"pending" | "verified" | "failed"
domain.updatedAtrequiredstring (date-time)

DELETE /domains/{id}Full-access live key

Remove a sending domain.

Path parameters

FieldTypeNotes
idrequiredstring

POST /domains/{id}/blocklist-checkFull-access live key

Check the domain against the monitored blocklists now.

Path parameters

FieldTypeNotes
idrequiredstring

Response 200

FieldTypeNotes
blocklistStatusobject
blocklistStatus.checkedAtrequiredstring (date-time) or null
blocklistStatus.listedrequiredboolean
blocklistStatus.listedOnrequiredstring[]
dmarcrequiredobject
dmarc.notesrequiredstring[]
dmarc.recordrequiredobject
dmarc.record.hostrequiredstring
dmarc.record.priorityinteger-9007199254740991 to 9007199254740991
dmarc.record.purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dmarc.record.typerequired"CNAME" | "TXT" | "MX"
dmarc.record.valuerequiredstring
dnsRecordsrequiredobject[]
dnsRecords[].hostrequiredstring
dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
dnsRecords[].valuerequiredstring
dnsRecords[].verifiedrequiredboolean
domainrequiredobject
domain.accountIdrequiredstring (uuid)
domain.createdAtrequiredstring (date-time)
domain.dkimSelectorrequiredstring
domain.dkimVerifiedAtrequiredstring (date-time) or null
domain.domainrequiredstringlength 3 to 253
domain.idrequiredstring (uuid)
domain.lastCheckedAtrequiredstring (date-time) or null
domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domain.returnPathVerifiedAtrequiredstring (date-time) or null
domain.sendingSubdomainrequiredstringlength 3 to 253
domain.spfVerifiedAtrequiredstring (date-time) or null
domain.statusrequired"pending" | "verified" | "failed"
domain.updatedAtrequiredstring (date-time)

PUT /domains/{id}/return-pathFull-access live key

Set a custom return-path (bounce) subdomain.

Path parameters

FieldTypeNotes
idrequiredstring

Request body

FieldTypeNotes
returnPathSubdomainrequiredstringlength 3 to 253

Response 200

FieldTypeNotes
blocklistStatusobject
blocklistStatus.checkedAtrequiredstring (date-time) or null
blocklistStatus.listedrequiredboolean
blocklistStatus.listedOnrequiredstring[]
dmarcrequiredobject
dmarc.notesrequiredstring[]
dmarc.recordrequiredobject
dmarc.record.hostrequiredstring
dmarc.record.priorityinteger-9007199254740991 to 9007199254740991
dmarc.record.purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dmarc.record.typerequired"CNAME" | "TXT" | "MX"
dmarc.record.valuerequiredstring
dnsRecordsrequiredobject[]
dnsRecords[].hostrequiredstring
dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
dnsRecords[].valuerequiredstring
dnsRecords[].verifiedrequiredboolean
domainrequiredobject
domain.accountIdrequiredstring (uuid)
domain.createdAtrequiredstring (date-time)
domain.dkimSelectorrequiredstring
domain.dkimVerifiedAtrequiredstring (date-time) or null
domain.domainrequiredstringlength 3 to 253
domain.idrequiredstring (uuid)
domain.lastCheckedAtrequiredstring (date-time) or null
domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domain.returnPathVerifiedAtrequiredstring (date-time) or null
domain.sendingSubdomainrequiredstringlength 3 to 253
domain.spfVerifiedAtrequiredstring (date-time) or null
domain.statusrequired"pending" | "verified" | "failed"
domain.updatedAtrequiredstring (date-time)

POST /domains/{id}/verifyFull-access live key

Re-check a domain's DNS records now.

Path parameters

FieldTypeNotes
idrequiredstring

Response 200

FieldTypeNotes
blocklistStatusobject
blocklistStatus.checkedAtrequiredstring (date-time) or null
blocklistStatus.listedrequiredboolean
blocklistStatus.listedOnrequiredstring[]
dmarcrequiredobject
dmarc.notesrequiredstring[]
dmarc.recordrequiredobject
dmarc.record.hostrequiredstring
dmarc.record.priorityinteger-9007199254740991 to 9007199254740991
dmarc.record.purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dmarc.record.typerequired"CNAME" | "TXT" | "MX"
dmarc.record.valuerequiredstring
dnsRecordsrequiredobject[]
dnsRecords[].hostrequiredstring
dnsRecords[].priorityinteger-9007199254740991 to 9007199254740991
dnsRecords[].purposerequired"dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc"
dnsRecords[].typerequired"CNAME" | "TXT" | "MX"
dnsRecords[].valuerequiredstring
dnsRecords[].verifiedrequiredboolean
domainrequiredobject
domain.accountIdrequiredstring (uuid)
domain.createdAtrequiredstring (date-time)
domain.dkimSelectorrequiredstring
domain.dkimVerifiedAtrequiredstring (date-time) or null
domain.domainrequiredstringlength 3 to 253
domain.idrequiredstring (uuid)
domain.lastCheckedAtrequiredstring (date-time) or null
domain.returnPathSubdomainrequiredstring or nulllength 3 to 253
domain.returnPathVerifiedAtrequiredstring (date-time) or null
domain.sendingSubdomainrequiredstringlength 3 to 253
domain.spfVerifiedAtrequiredstring (date-time) or null
domain.statusrequired"pending" | "verified" | "failed"
domain.updatedAtrequiredstring (date-time)

Logs and analytics

GET /dmarc/summaryFull-access live key

Aggregated DMARC report results for one domain.

Query parameters

FieldTypeNotes
domainrequiredstringlength 1 to 253
daysinteger1 to 365, default 30

GET /events/logsFull-access live key

Search email event logs.

Query parameters

FieldTypeNotes
accountIdstring (uuid)
recipientstring
subjectstring
status"delivered" | "bounce" | "complaint" | "reject" | "open" | "click"
domainstring
fromany
toany
cursorstring
limitinteger1 to 100, default 20
environment"production" | "test"
stream"transactional" | "broadcast"

Response 200

FieldTypeNotes
itemsrequiredobject[]
items[].accountIdrequiredstring (uuid)
items[].createdAtrequiredstring
items[].domainrequiredstring | null
items[].emailIdrequiredstring (uuid) or null
items[].eventTyperequiredstring
items[].idrequiredstring (uuid)
items[].messageIdrequiredstring | null
items[].rawPayloadrequiredany
items[].recipientrequiredstring | null
items[].subjectrequiredstring | null
nextCursorstring

GET /events/summaryFull-access live key

Delivery, bounce and complaint totals for a period.

Query parameters

FieldTypeNotes
environment"production" | "test"

Response 200

FieldTypeNotes
bounceRatePctrequirednumber | null
bounceRateTrendPprequirednumber | null
complaintRatePctrequirednumber | null
deliveryRatePctrequirednumber | null
deliveryRateTrendPprequirednumber | null
sendsThisMonthrequiredinteger0 to 9007199254740991
sendsTodayrequiredinteger0 to 9007199254740991
sendsTrendPctrequirednumber | null

GET /events/summary/dailyFull-access live key

The same totals, one row per day.

Query parameters

FieldTypeNotes
environment"production" | "test"

Response 200

FieldTypeNotes
daysrequiredobject[]
days[].bouncedrequiredinteger0 to 9007199254740991
days[].complainedrequiredinteger0 to 9007199254740991
days[].daterequiredstring
days[].deliveredrequiredinteger0 to 9007199254740991

GET /events/tracking/domainsFull-access live key

Open and click tracking settings per domain.

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Response 200

FieldTypeNotes
itemsrequiredobject[]
items[].accountIdrequiredstring (uuid)
items[].clickTrackingEnabledrequiredboolean
items[].domainrequiredstring
items[].domainIdrequiredstring (uuid) or null
items[].idrequiredstring (uuid)
items[].openTrackingEnabledrequiredboolean

PUT /events/tracking/domainsFull-access live key

Turn open or click tracking on or off for a domain.

Request body

FieldTypeNotes
accountIdstring (uuid)
clickTrackingEnabledboolean
domainrequiredstring
domainIdstring (uuid)
openTrackingEnabledboolean

Response 200

FieldTypeNotes
accountIdrequiredstring (uuid)
clickTrackingEnabledrequiredboolean
domainrequiredstring
domainIdrequiredstring (uuid) or null
idrequiredstring (uuid)
openTrackingEnabledrequiredboolean

GET /logs/requestsFull-access live key

Your recent API requests and their status codes.

Query parameters

FieldTypeNotes
statusinteger100 to 599
min_statusinteger100 to 599
routestringlength 0 to 200
key_idstring (uuid)
fromstring (date-time)
tostring (date-time)
beforestring (uuid)
limitinteger1 to 200, default 50

Suppressions

GET /broadcast/unsubscribesFull-access live key

List recipients who unsubscribed from broadcast mail.

Query parameters

FieldTypeNotes
beforestring (uuid)
limitinteger1 to 200, default 50

GET /suppressionsFull-access live key

List suppressed addresses.

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Response 200

FieldTypeNotes
itemsrequiredobject[]
items[].accountIdrequiredstring (uuid)
items[].createdAtrequiredstring
items[].emailrequiredstring
items[].idrequiredstring (uuid)
items[].reasonrequiredstring

POST /suppressionsFull-access live key

Suppress one address.

Request body

FieldTypeNotes
accountIdstring (uuid)
emailrequiredstring (email)

Response 201

FieldTypeNotes
accountIdrequiredstring (uuid)
createdAtrequiredstring
emailrequiredstring
idrequiredstring (uuid)
reasonrequiredstring

POST /suppressions/batchFull-access live key

Suppress many addresses in one request.

Request body

FieldTypeNotes
emailsrequiredstring[]1 to 1000 items

DELETE /suppressions/{email}Full-access live key

Remove one address from the suppression list.

Path parameters

FieldTypeNotes
emailrequiredstring

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Webhooks

GET /webhooks/endpointsFull-access live key

List webhook endpoints.

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Response 200

FieldTypeNotes
itemsrequiredobject[]
items[].accountIdrequiredstring (uuid)
items[].createdAtrequiredstring
items[].enabledrequiredboolean
items[].eventTypesrequiredstring[]
items[].idrequiredstring (uuid)
items[].updatedAtrequiredstring
items[].urlrequiredstring

POST /webhooks/endpointsFull-access live key

Create a webhook endpoint. The signing secret is returned once.

Request body

FieldTypeNotes
accountIdstring (uuid)
eventTypesrequired"delivered" | "bounced" | "complained" | "opened" | "clicked" | "sent" | "failed" | "scheduled" | "domain.created" | "domain.updated" | "domain.deleted" | "suppression.added" | "suppression.removed" | "broadcast.unsubscribed" | "received"[]1 to any items
urlrequiredstring (uri)

Response 201

FieldTypeNotes
accountIdrequiredstring (uuid)
createdAtrequiredstring
enabledrequiredboolean
eventTypesrequiredstring[]
idrequiredstring (uuid)
secretrequiredstring
updatedAtrequiredstring
urlrequiredstring

PATCH /webhooks/endpoints/{id}Full-access live key

Change an endpoint's URL, events or enabled state.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Request body

FieldTypeNotes
enabledboolean
eventTypes"delivered" | "bounced" | "complained" | "opened" | "clicked" | "sent" | "failed" | "scheduled" | "domain.created" | "domain.updated" | "domain.deleted" | "suppression.added" | "suppression.removed" | "broadcast.unsubscribed" | "received"[]1 to any items
urlstring (uri)

Response 200

FieldTypeNotes
accountIdrequiredstring (uuid)
createdAtrequiredstring
enabledrequiredboolean
eventTypesrequiredstring[]
idrequiredstring (uuid)
updatedAtrequiredstring
urlrequiredstring

DELETE /webhooks/endpoints/{id}Full-access live key

Delete a webhook endpoint.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Query parameters

FieldTypeNotes
accountIdstring (uuid)

GET /webhooks/endpoints/{id}/deliveriesFull-access live key

Recent delivery attempts for one endpoint.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

Query parameters

FieldTypeNotes
limitinteger1 to 100, default 20
beforestring (uuid)

Inbound

GET /inbound/emailsFull-access live key

List received emails.

Query parameters

FieldTypeNotes
domainstringlength 0 to 253
fromstring (date-time)
tostring (date-time)
beforestring (uuid)
limitinteger1 to 100, default 20

GET /inbound/emails/{id}Full-access live key

Fetch one received email.

Path parameters

FieldTypeNotes
idrequiredstring (uuid)

GET /inbound/routesFull-access live key

List inbound routes.

Query parameters

FieldTypeNotes
accountIdstring (uuid)

Response 200

FieldTypeNotes
itemsrequiredobject[]
items[].accountIdrequiredstring (uuid)
items[].addressrequiredstring | null
items[].catchAllAddressrequiredstring
items[].domainrequiredstring
items[].domainIdrequiredstring (uuid) or null
items[].idrequiredstring (uuid)
items[].tokenrequiredstring
items[].webhookUrlrequiredstring

POST /inbound/routesFull-access live key

Route mail received on your domain to a webhook.

Request body

FieldTypeNotes
accountIdstring (uuid)
addressstringlength 1 to any
domainrequiredstring
domainIdstring (uuid)
webhookUrlrequiredstring (uri)

Response 201

FieldTypeNotes
accountIdrequiredstring (uuid)
addressrequiredstring | null
catchAllAddressrequiredstring
domainrequiredstring
domainIdrequiredstring (uuid) or null
idrequiredstring (uuid)
signingSecretrequiredstring
tokenrequiredstring
webhookUrlrequiredstring