Email Sending

Send an email

POST/accounts/{account_id}/email/sending/send

Send a raw MIME email

POST/accounts/{account_id}/email/sending/send_raw

ModelsExpand Collapse

EmailSendingSendResponse object { delivered, message_id, permanent_bounces, 2 more }

delivered: array of string

Email addresses to which the message was delivered immediately.

message_id: string

Message ID of the sent email.

permanent_bounces: array of string

Email addresses that permanently bounced.

queued: array of string

Email addresses for which delivery was queued for later.

suppressed_recipients: array of string

Email addresses dropped because they are on the suppression list. Returned when suppressed-recipient dropping is enabled for the sending subdomain; otherwise the request fails instead.

EmailSendingSendRawResponse object { delivered, message_id, permanent_bounces, 2 more }

delivered: array of string

Email addresses to which the message was delivered immediately.

message_id: string

Message ID of the sent email.

permanent_bounces: array of string

Email addresses that permanently bounced.

queued: array of string

Email addresses for which delivery was queued for later.

suppressed_recipients: array of string

Email addresses dropped because they are on the suppression list. Returned when suppressed-recipient dropping is enabled for the sending subdomain; otherwise the request fails instead.

Email SendingSuppressions

List account Email Sending suppressions

GET/accounts/{account_id}/email/sending/suppressions

Get account Email Sending suppression

GET/accounts/{account_id}/email/sending/suppressions/{suppression_id}

Create account Email Sending suppression

POST/accounts/{account_id}/email/sending/suppressions

Update account Email Sending suppression

PATCH/accounts/{account_id}/email/sending/suppressions/{suppression_id}

Delete account Email Sending suppression

DELETE/accounts/{account_id}/email/sending/suppressions/{suppression_id}

Bulk import account Email Sending suppressions

POST/accounts/{account_id}/email/sending/suppressions/bulk

ModelsExpand Collapse

SuppressionListResponse object { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string

formatdate-time

read_only: boolean

Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason.

reason: string

note: optional string

SuppressionGetResponse object { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string

formatdate-time

read_only: boolean

Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason.

reason: string

note: optional string

SuppressionCreateResponse object { id }

id: string

formatuuid

SuppressionEditResponse object { id, created_at, email, 4 more }

id: string

formatuuid

created_at: string

formatdate-time

email: string

formatemail

expires_at: string

formatdate-time

read_only: boolean

Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason.

reason: string

note: optional string

SuppressionDeleteResponse object { id }

id: string

formatuuid

SuppressionImportResponse object { deduplicated, errors, invalid, 4 more }

deduplicated: number

errors: number

invalid: number

items: array of object { index, status, id, 2 more }

index: number

status: "processed" or "invalid" or "error" or "skipped"

One of the following:

"processed"

"invalid"

"error"

"skipped"

id: optional string

formatuuid

email: optional string

formatemail

error: optional string

processed: number

skipped: number

total: number

Email SendingSubdomains

List sending subdomains

GET/zones/{zone_id}/email/sending/subdomains

Get a sending subdomain

GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

Create a sending subdomain

POST/zones/{zone_id}/email/sending/subdomains

Update a sending subdomain

PATCH/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

Delete a sending subdomain

DELETE/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

ModelsExpand Collapse

SubdomainListResponse object { enabled, name, tag, 6 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: optional boolean

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainGetResponse object { enabled, name, tag, 6 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: optional boolean

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainCreateResponse object { enabled, name, tag, 6 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: optional boolean

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainEditResponse object { enabled, name, tag, 6 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: optional boolean

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainDeleteResponse object { errors, messages, success }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

Email SendingSubdomainsDNS

Get sending subdomain DNS records

GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns