GET /broadcast/settingsFull-access live key
Whether the broadcast stream is on, paused, or unavailable for this account.
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.
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.
Whether the broadcast stream is on, paused, or unavailable for this account.
List sent emails, newest first.
| Field | Type | Notes |
|---|---|---|
| status | "queued" | "scheduled" | "sent" | "send_error" | "canceled" | |
| tag_name | string | length 1 to 256 |
| tag_value | string | length 1 to 256 |
| from | string (date-time) | |
| to | string (date-time) | |
| before | string (uuid) | |
| limit | integer | 1 to 100, default 20 |
| Field | Type | Notes |
|---|---|---|
| datarequired | object[] | |
| data[].created_atrequired | string (date-time) | |
| data[].errorrequired | string | null | |
| data[].idrequired | string (uuid) | |
| data[].send_atrequired | string (date-time) or null | |
| data[].sent_atrequired | string (date-time) or null | |
| data[].statusrequired | "queued" | "scheduled" | "sent" | "send_error" | "canceled" | |
| data[].subjectrequired | string | |
| data[].tagsrequired | object[] | |
| data[].tags[].namerequired | string | length 1 to 256 |
| data[].tags[].valuerequired | string | length 1 to 256 |
| data[].torequired | string[] | |
| has_morerequired | boolean | |
| next_beforerequired | string (uuid) or null |
Send one email.
| Field | Type | Notes |
|---|---|---|
| attachments | object[] | 0 to 10 items |
| bcc | string or string[] | length 3 to 320, 1 to 50 items |
| cc | string or string[] | length 3 to 320, 1 to 50 items |
| fromrequired | string | length 3 to 320 |
| headers | object | Up 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. |
| html | string | |
| reply_to | string | length 3 to 320 |
| send_at | string (date-time) | |
| stream | "transactional" | "broadcast" | |
| subject | string | length 1 to 998 |
| tags | object[] | 0 to 10 items |
| tags[].namerequired | string | length 1 to 256 |
| tags[].valuerequired | string | length 1 to 256 |
| template_id | string (uuid) | |
| text | string | |
| torequired | string or string[] | length 3 to 320, 1 to 50 items |
| variables | object |
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) | |
| statusrequired | "queued" | "scheduled" | "sent" | "send_error" | "canceled" |
Send up to 100 emails in one request. Failures are reported per item.
| Field | Type | Notes |
|---|---|---|
| emailsrequired | object[] | 1 to 100 items |
| emails[].attachments | object[] | 0 to 10 items |
| emails[].bcc | string or string[] | length 3 to 320, 1 to 50 items |
| emails[].cc | string or string[] | length 3 to 320, 1 to 50 items |
| emails[].fromrequired | string | length 3 to 320 |
| emails[].headers | object | Up 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[].html | string | |
| emails[].reply_to | string | length 3 to 320 |
| emails[].send_at | string (date-time) | |
| emails[].stream | "transactional" | "broadcast" | |
| emails[].subject | string | length 1 to 998 |
| emails[].tags | object[] | 0 to 10 items |
| emails[].tags[].namerequired | string | length 1 to 256 |
| emails[].tags[].valuerequired | string | length 1 to 256 |
| emails[].template_id | string (uuid) | |
| emails[].text | string | |
| emails[].torequired | string or string[] | length 3 to 320, 1 to 50 items |
| emails[].variables | object |
| Field | Type | Notes |
|---|---|---|
| resultsrequired | object[] |
Check an address for syntax, MX records and disposable domains without sending.
| Field | Type | Notes |
|---|---|---|
| emailrequired | string | length 3 to 320 |
| Field | Type | Notes |
|---|---|---|
| disposablerequired | boolean | |
| emailrequired | string | |
| mx_foundrequired | boolean | |
| reason | string | |
| role_accountrequired | boolean | |
| syntax_validrequired | boolean | |
| validrequired | boolean |
Fetch one email and its delivery status.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| created_atrequired | string (date-time) | |
| errorrequired | string | null | |
| idrequired | string (uuid) | |
| send_atrequired | string (date-time) or null | |
| sent_atrequired | string (date-time) or null | |
| statusrequired | "queued" | "scheduled" | "sent" | "send_error" | "canceled" | |
| subjectrequired | string | |
| tagsrequired | object[] | |
| tags[].namerequired | string | length 1 to 256 |
| tags[].valuerequired | string | length 1 to 256 |
| torequired | string[] |
Reschedule a scheduled email.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| send_atrequired | string (date-time) |
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) | |
| send_atrequired | string (date-time) | |
| statusrequired | "queued" | "scheduled" | "sent" | "send_error" | "canceled" |
Cancel a scheduled email before it sends.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) | |
| statusrequired | "canceled" |
Deliverability hints for one sent email.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
Create a read-only share link for one email.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| expires_in_hours | integer | 1 to 720, default 168 |
| Field | Type | Notes |
|---|---|---|
| expires_atrequired | string (date-time) | |
| urlrequired | string |
List templates.
Create a template (version 1).
Fetch a template's current version.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
Update a template. Creates a new version.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
Delete a template and its version history.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
List every version of a template.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
List sending domains.
| Field | Type | Notes |
|---|---|---|
| domainsrequired | object[] | |
| domains[].blocklistStatus | object | |
| domains[].blocklistStatus.checkedAtrequired | string (date-time) or null | |
| domains[].blocklistStatus.listedrequired | boolean | |
| domains[].blocklistStatus.listedOnrequired | string[] | |
| domains[].dmarcrequired | object | |
| domains[].dmarc.notesrequired | string[] | |
| domains[].dmarc.recordrequired | object | |
| domains[].dnsRecordsrequired | object[] | |
| domains[].dnsRecords[].hostrequired | string | |
| domains[].dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| domains[].dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| domains[].dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| domains[].dnsRecords[].valuerequired | string | |
| domains[].dnsRecords[].verifiedrequired | boolean | |
| domains[].domainrequired | object | |
| domains[].domain.accountIdrequired | string (uuid) | |
| domains[].domain.createdAtrequired | string (date-time) | |
| domains[].domain.dkimSelectorrequired | string | |
| domains[].domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domains[].domain.domainrequired | string | length 3 to 253 |
| domains[].domain.idrequired | string (uuid) | |
| domains[].domain.lastCheckedAtrequired | string (date-time) or null | |
| domains[].domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domains[].domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domains[].domain.sendingSubdomainrequired | string | length 3 to 253 |
| domains[].domain.spfVerifiedAtrequired | string (date-time) or null | |
| domains[].domain.statusrequired | "pending" | "verified" | "failed" | |
| domains[].domain.updatedAtrequired | string (date-time) | |
| limitrequired | integer | -9007199254740991 to 9007199254740991 |
Add a sending domain and get its DNS records.
| Field | Type | Notes |
|---|---|---|
| domainrequired | string | length 3 to 253 |
| returnPathSubdomain | string | length 3 to 253 |
| sendingSubdomain | string | length 3 to 253 |
| Field | Type | Notes |
|---|---|---|
| blocklistStatus | object | |
| blocklistStatus.checkedAtrequired | string (date-time) or null | |
| blocklistStatus.listedrequired | boolean | |
| blocklistStatus.listedOnrequired | string[] | |
| dmarcrequired | object | |
| dmarc.notesrequired | string[] | |
| dmarc.recordrequired | object | |
| dmarc.record.hostrequired | string | |
| dmarc.record.priority | integer | -9007199254740991 to 9007199254740991 |
| dmarc.record.purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dmarc.record.typerequired | "CNAME" | "TXT" | "MX" | |
| dmarc.record.valuerequired | string | |
| dnsRecordsrequired | object[] | |
| dnsRecords[].hostrequired | string | |
| dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| dnsRecords[].valuerequired | string | |
| dnsRecords[].verifiedrequired | boolean | |
| domainrequired | object | |
| domain.accountIdrequired | string (uuid) | |
| domain.createdAtrequired | string (date-time) | |
| domain.dkimSelectorrequired | string | |
| domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domain.domainrequired | string | length 3 to 253 |
| domain.idrequired | string (uuid) | |
| domain.lastCheckedAtrequired | string (date-time) or null | |
| domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domain.sendingSubdomainrequired | string | length 3 to 253 |
| domain.spfVerifiedAtrequired | string (date-time) or null | |
| domain.statusrequired | "pending" | "verified" | "failed" | |
| domain.updatedAtrequired | string (date-time) |
Start claiming a domain another account registered.
| Field | Type | Notes |
|---|---|---|
| domainrequired | string | length 3 to 253 |
| Field | Type | Notes |
|---|---|---|
| domainrequired | string | |
| txtNamerequired | string | |
| txtValuerequired | string |
Finish a domain claim once the TXT record is live.
| Field | Type | Notes |
|---|---|---|
| domainrequired | string | length 3 to 253 |
Fetch one domain and its DNS record status.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
| Field | Type | Notes |
|---|---|---|
| blocklistStatus | object | |
| blocklistStatus.checkedAtrequired | string (date-time) or null | |
| blocklistStatus.listedrequired | boolean | |
| blocklistStatus.listedOnrequired | string[] | |
| dmarcrequired | object | |
| dmarc.notesrequired | string[] | |
| dmarc.recordrequired | object | |
| dmarc.record.hostrequired | string | |
| dmarc.record.priority | integer | -9007199254740991 to 9007199254740991 |
| dmarc.record.purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dmarc.record.typerequired | "CNAME" | "TXT" | "MX" | |
| dmarc.record.valuerequired | string | |
| dnsRecordsrequired | object[] | |
| dnsRecords[].hostrequired | string | |
| dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| dnsRecords[].valuerequired | string | |
| dnsRecords[].verifiedrequired | boolean | |
| domainrequired | object | |
| domain.accountIdrequired | string (uuid) | |
| domain.createdAtrequired | string (date-time) | |
| domain.dkimSelectorrequired | string | |
| domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domain.domainrequired | string | length 3 to 253 |
| domain.idrequired | string (uuid) | |
| domain.lastCheckedAtrequired | string (date-time) or null | |
| domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domain.sendingSubdomainrequired | string | length 3 to 253 |
| domain.spfVerifiedAtrequired | string (date-time) or null | |
| domain.statusrequired | "pending" | "verified" | "failed" | |
| domain.updatedAtrequired | string (date-time) |
Remove a sending domain.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
Check the domain against the monitored blocklists now.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
| Field | Type | Notes |
|---|---|---|
| blocklistStatus | object | |
| blocklistStatus.checkedAtrequired | string (date-time) or null | |
| blocklistStatus.listedrequired | boolean | |
| blocklistStatus.listedOnrequired | string[] | |
| dmarcrequired | object | |
| dmarc.notesrequired | string[] | |
| dmarc.recordrequired | object | |
| dmarc.record.hostrequired | string | |
| dmarc.record.priority | integer | -9007199254740991 to 9007199254740991 |
| dmarc.record.purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dmarc.record.typerequired | "CNAME" | "TXT" | "MX" | |
| dmarc.record.valuerequired | string | |
| dnsRecordsrequired | object[] | |
| dnsRecords[].hostrequired | string | |
| dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| dnsRecords[].valuerequired | string | |
| dnsRecords[].verifiedrequired | boolean | |
| domainrequired | object | |
| domain.accountIdrequired | string (uuid) | |
| domain.createdAtrequired | string (date-time) | |
| domain.dkimSelectorrequired | string | |
| domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domain.domainrequired | string | length 3 to 253 |
| domain.idrequired | string (uuid) | |
| domain.lastCheckedAtrequired | string (date-time) or null | |
| domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domain.sendingSubdomainrequired | string | length 3 to 253 |
| domain.spfVerifiedAtrequired | string (date-time) or null | |
| domain.statusrequired | "pending" | "verified" | "failed" | |
| domain.updatedAtrequired | string (date-time) |
Set a custom return-path (bounce) subdomain.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
| Field | Type | Notes |
|---|---|---|
| returnPathSubdomainrequired | string | length 3 to 253 |
| Field | Type | Notes |
|---|---|---|
| blocklistStatus | object | |
| blocklistStatus.checkedAtrequired | string (date-time) or null | |
| blocklistStatus.listedrequired | boolean | |
| blocklistStatus.listedOnrequired | string[] | |
| dmarcrequired | object | |
| dmarc.notesrequired | string[] | |
| dmarc.recordrequired | object | |
| dmarc.record.hostrequired | string | |
| dmarc.record.priority | integer | -9007199254740991 to 9007199254740991 |
| dmarc.record.purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dmarc.record.typerequired | "CNAME" | "TXT" | "MX" | |
| dmarc.record.valuerequired | string | |
| dnsRecordsrequired | object[] | |
| dnsRecords[].hostrequired | string | |
| dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| dnsRecords[].valuerequired | string | |
| dnsRecords[].verifiedrequired | boolean | |
| domainrequired | object | |
| domain.accountIdrequired | string (uuid) | |
| domain.createdAtrequired | string (date-time) | |
| domain.dkimSelectorrequired | string | |
| domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domain.domainrequired | string | length 3 to 253 |
| domain.idrequired | string (uuid) | |
| domain.lastCheckedAtrequired | string (date-time) or null | |
| domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domain.sendingSubdomainrequired | string | length 3 to 253 |
| domain.spfVerifiedAtrequired | string (date-time) or null | |
| domain.statusrequired | "pending" | "verified" | "failed" | |
| domain.updatedAtrequired | string (date-time) |
Re-check a domain's DNS records now.
| Field | Type | Notes |
|---|---|---|
| idrequired | string |
| Field | Type | Notes |
|---|---|---|
| blocklistStatus | object | |
| blocklistStatus.checkedAtrequired | string (date-time) or null | |
| blocklistStatus.listedrequired | boolean | |
| blocklistStatus.listedOnrequired | string[] | |
| dmarcrequired | object | |
| dmarc.notesrequired | string[] | |
| dmarc.recordrequired | object | |
| dmarc.record.hostrequired | string | |
| dmarc.record.priority | integer | -9007199254740991 to 9007199254740991 |
| dmarc.record.purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dmarc.record.typerequired | "CNAME" | "TXT" | "MX" | |
| dmarc.record.valuerequired | string | |
| dnsRecordsrequired | object[] | |
| dnsRecords[].hostrequired | string | |
| dnsRecords[].priority | integer | -9007199254740991 to 9007199254740991 |
| dnsRecords[].purposerequired | "dkim" | "spf" | "return-path-mx" | "return-path-spf" | "dmarc" | |
| dnsRecords[].typerequired | "CNAME" | "TXT" | "MX" | |
| dnsRecords[].valuerequired | string | |
| dnsRecords[].verifiedrequired | boolean | |
| domainrequired | object | |
| domain.accountIdrequired | string (uuid) | |
| domain.createdAtrequired | string (date-time) | |
| domain.dkimSelectorrequired | string | |
| domain.dkimVerifiedAtrequired | string (date-time) or null | |
| domain.domainrequired | string | length 3 to 253 |
| domain.idrequired | string (uuid) | |
| domain.lastCheckedAtrequired | string (date-time) or null | |
| domain.returnPathSubdomainrequired | string or null | length 3 to 253 |
| domain.returnPathVerifiedAtrequired | string (date-time) or null | |
| domain.sendingSubdomainrequired | string | length 3 to 253 |
| domain.spfVerifiedAtrequired | string (date-time) or null | |
| domain.statusrequired | "pending" | "verified" | "failed" | |
| domain.updatedAtrequired | string (date-time) |
Aggregated DMARC report results for one domain.
| Field | Type | Notes |
|---|---|---|
| domainrequired | string | length 1 to 253 |
| days | integer | 1 to 365, default 30 |
Search email event logs.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) | |
| recipient | string | |
| subject | string | |
| status | "delivered" | "bounce" | "complaint" | "reject" | "open" | "click" | |
| domain | string | |
| from | any | |
| to | any | |
| cursor | string | |
| limit | integer | 1 to 100, default 20 |
| environment | "production" | "test" | |
| stream | "transactional" | "broadcast" |
| Field | Type | Notes |
|---|---|---|
| itemsrequired | object[] | |
| items[].accountIdrequired | string (uuid) | |
| items[].createdAtrequired | string | |
| items[].domainrequired | string | null | |
| items[].emailIdrequired | string (uuid) or null | |
| items[].eventTyperequired | string | |
| items[].idrequired | string (uuid) | |
| items[].messageIdrequired | string | null | |
| items[].rawPayloadrequired | any | |
| items[].recipientrequired | string | null | |
| items[].subjectrequired | string | null | |
| nextCursor | string |
Delivery, bounce and complaint totals for a period.
| Field | Type | Notes |
|---|---|---|
| environment | "production" | "test" |
| Field | Type | Notes |
|---|---|---|
| bounceRatePctrequired | number | null | |
| bounceRateTrendPprequired | number | null | |
| complaintRatePctrequired | number | null | |
| deliveryRatePctrequired | number | null | |
| deliveryRateTrendPprequired | number | null | |
| sendsThisMonthrequired | integer | 0 to 9007199254740991 |
| sendsTodayrequired | integer | 0 to 9007199254740991 |
| sendsTrendPctrequired | number | null |
The same totals, one row per day.
| Field | Type | Notes |
|---|---|---|
| environment | "production" | "test" |
| Field | Type | Notes |
|---|---|---|
| daysrequired | object[] | |
| days[].bouncedrequired | integer | 0 to 9007199254740991 |
| days[].complainedrequired | integer | 0 to 9007199254740991 |
| days[].daterequired | string | |
| days[].deliveredrequired | integer | 0 to 9007199254740991 |
Open and click tracking settings per domain.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| itemsrequired | object[] | |
| items[].accountIdrequired | string (uuid) | |
| items[].clickTrackingEnabledrequired | boolean | |
| items[].domainrequired | string | |
| items[].domainIdrequired | string (uuid) or null | |
| items[].idrequired | string (uuid) | |
| items[].openTrackingEnabledrequired | boolean |
Turn open or click tracking on or off for a domain.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) | |
| clickTrackingEnabled | boolean | |
| domainrequired | string | |
| domainId | string (uuid) | |
| openTrackingEnabled | boolean |
| Field | Type | Notes |
|---|---|---|
| accountIdrequired | string (uuid) | |
| clickTrackingEnabledrequired | boolean | |
| domainrequired | string | |
| domainIdrequired | string (uuid) or null | |
| idrequired | string (uuid) | |
| openTrackingEnabledrequired | boolean |
Your recent API requests and their status codes.
| Field | Type | Notes |
|---|---|---|
| status | integer | 100 to 599 |
| min_status | integer | 100 to 599 |
| route | string | length 0 to 200 |
| key_id | string (uuid) | |
| from | string (date-time) | |
| to | string (date-time) | |
| before | string (uuid) | |
| limit | integer | 1 to 200, default 50 |
List recipients who unsubscribed from broadcast mail.
| Field | Type | Notes |
|---|---|---|
| before | string (uuid) | |
| limit | integer | 1 to 200, default 50 |
Remove one broadcast unsubscribe.
| Field | Type | Notes |
|---|---|---|
| emailrequired | string |
List suppressed addresses.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| itemsrequired | object[] | |
| items[].accountIdrequired | string (uuid) | |
| items[].createdAtrequired | string | |
| items[].emailrequired | string | |
| items[].idrequired | string (uuid) | |
| items[].reasonrequired | string |
Suppress one address.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) | |
| emailrequired | string (email) |
| Field | Type | Notes |
|---|---|---|
| accountIdrequired | string (uuid) | |
| createdAtrequired | string | |
| emailrequired | string | |
| idrequired | string (uuid) | |
| reasonrequired | string |
Suppress many addresses in one request.
| Field | Type | Notes |
|---|---|---|
| emailsrequired | string[] | 1 to 1000 items |
Remove many addresses in one request.
| Field | Type | Notes |
|---|---|---|
| emailsrequired | string[] | 1 to 1000 items |
Remove one address from the suppression list.
| Field | Type | Notes |
|---|---|---|
| emailrequired | string |
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
Send one past delivery again.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
List webhook endpoints.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| itemsrequired | object[] | |
| items[].accountIdrequired | string (uuid) | |
| items[].createdAtrequired | string | |
| items[].enabledrequired | boolean | |
| items[].eventTypesrequired | string[] | |
| items[].idrequired | string (uuid) | |
| items[].updatedAtrequired | string | |
| items[].urlrequired | string |
Create a webhook endpoint. The signing secret is returned once.
| Field | Type | Notes |
|---|---|---|
| accountId | string (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 |
| urlrequired | string (uri) |
| Field | Type | Notes |
|---|---|---|
| accountIdrequired | string (uuid) | |
| createdAtrequired | string | |
| enabledrequired | boolean | |
| eventTypesrequired | string[] | |
| idrequired | string (uuid) | |
| secretrequired | string | |
| updatedAtrequired | string | |
| urlrequired | string |
Change an endpoint's URL, events or enabled state.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| enabled | boolean | |
| 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 |
| url | string (uri) |
| Field | Type | Notes |
|---|---|---|
| accountIdrequired | string (uuid) | |
| createdAtrequired | string | |
| enabledrequired | boolean | |
| eventTypesrequired | string[] | |
| idrequired | string (uuid) | |
| updatedAtrequired | string | |
| urlrequired | string |
Delete a webhook endpoint.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
Recent delivery attempts for one endpoint.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| limit | integer | 1 to 100, default 20 |
| before | string (uuid) |
Rotate an endpoint's signing secret.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
List received emails.
| Field | Type | Notes |
|---|---|---|
| domain | string | length 0 to 253 |
| from | string (date-time) | |
| to | string (date-time) | |
| before | string (uuid) | |
| limit | integer | 1 to 100, default 20 |
Fetch one received email.
| Field | Type | Notes |
|---|---|---|
| idrequired | string (uuid) |
List inbound routes.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) |
| Field | Type | Notes |
|---|---|---|
| itemsrequired | object[] | |
| items[].accountIdrequired | string (uuid) | |
| items[].addressrequired | string | null | |
| items[].catchAllAddressrequired | string | |
| items[].domainrequired | string | |
| items[].domainIdrequired | string (uuid) or null | |
| items[].idrequired | string (uuid) | |
| items[].tokenrequired | string | |
| items[].webhookUrlrequired | string |
Route mail received on your domain to a webhook.
| Field | Type | Notes |
|---|---|---|
| accountId | string (uuid) | |
| address | string | length 1 to any |
| domainrequired | string | |
| domainId | string (uuid) | |
| webhookUrlrequired | string (uri) |
| Field | Type | Notes |
|---|---|---|
| accountIdrequired | string (uuid) | |
| addressrequired | string | null | |
| catchAllAddressrequired | string | |
| domainrequired | string | |
| domainIdrequired | string (uuid) or null | |
| idrequired | string (uuid) | |
| signingSecretrequired | string | |
| tokenrequired | string | |
| webhookUrlrequired | string |