Skip to content
Cloudflare API
Start here
API Reference
Email Sending

Subdomains

List sending subdomains
client.emailSending.subdomains.list(SubdomainListParams { zone_id } params, RequestOptionsoptions?): SinglePage<SubdomainListResponse { email_sending_enabled, name, tag, 5 more } >
GET/zones/{zone_id}/email/sending/subdomains
Get a sending subdomain
client.emailSending.subdomains.get(stringsubdomainId, SubdomainGetParams { zone_id } params, RequestOptionsoptions?): SubdomainGetResponse { email_sending_enabled, name, tag, 5 more }
GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}
Create a sending subdomain
client.emailSending.subdomains.create(SubdomainCreateParams { zone_id, name } params, RequestOptionsoptions?): SubdomainCreateResponse { email_sending_enabled, name, tag, 5 more }
POST/zones/{zone_id}/email/sending/subdomains
Delete a sending subdomain
client.emailSending.subdomains.delete(stringsubdomainId, SubdomainDeleteParams { zone_id } params, RequestOptionsoptions?): SubdomainDeleteResponse { errors, messages, success }
DELETE/zones/{zone_id}/email/sending/subdomains/{subdomain_id}
ModelsExpand Collapse
SubdomainListResponse { email_sending_enabled, name, tag, 5 more }
email_sending_enabled: boolean

Whether Email Sending is enabled on this subdomain.

name: string

The subdomain domain name.

tag: string

Sending subdomain identifier.

maxLength32
created?: string

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector?: string

The DKIM selector used for email signing.

email_sending_return_path_domain?: string

The return-path domain used for bounce handling.

enabled?: boolean

Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row.

modified?: string

The date and time the destination address was last modified.

formatdate-time
SubdomainGetResponse { email_sending_enabled, name, tag, 5 more }
email_sending_enabled: boolean

Whether Email Sending is enabled on this subdomain.

name: string

The subdomain domain name.

tag: string

Sending subdomain identifier.

maxLength32
created?: string

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector?: string

The DKIM selector used for email signing.

email_sending_return_path_domain?: string

The return-path domain used for bounce handling.

enabled?: boolean

Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row.

modified?: string

The date and time the destination address was last modified.

formatdate-time
SubdomainCreateResponse { email_sending_enabled, name, tag, 5 more }
email_sending_enabled: boolean

Whether Email Sending is enabled on this subdomain.

name: string

The subdomain domain name.

tag: string

Sending subdomain identifier.

maxLength32
created?: string

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector?: string

The DKIM selector used for email signing.

email_sending_return_path_domain?: string

The return-path domain used for bounce handling.

enabled?: boolean

Whether Email Routing (receiving) is enabled on this subdomain. Read-only; included for informational purposes since both services share the subdomain row.

modified?: string

The date and time the destination address was last modified.

formatdate-time
SubdomainDeleteResponse { errors, messages, success }
errors: Array<Error>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
messages: Array<Message>
code: number
minimum1000
message: string
documentation_url?: string
source?: Source { pointer }
pointer?: string
success: true

Whether the API call was successful.

SubdomainsDNS

Get sending subdomain DNS records
client.emailSending.subdomains.dns.get(stringsubdomainId, DNSGetParams { zone_id } params, RequestOptionsoptions?): SinglePage<DNSRecord { content, name, priority, 2 more } >
GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns