Skip to content
Cloudflare API
Start here
API Reference
Email Sending

Subdomains

List sending subdomains
email_sending.subdomains.list(SubdomainListParams**kwargs) -> SyncSinglePage[SubdomainListResponse]
GET/zones/{zone_id}/email/sending/subdomains
Get a sending subdomain
email_sending.subdomains.get(strsubdomain_id, SubdomainGetParams**kwargs) -> SubdomainGetResponse
GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}
Create a sending subdomain
email_sending.subdomains.create(SubdomainCreateParams**kwargs) -> SubdomainCreateResponse
POST/zones/{zone_id}/email/sending/subdomains
Delete a sending subdomain
email_sending.subdomains.delete(strsubdomain_id, SubdomainDeleteParams**kwargs) -> SubdomainDeleteResponse
DELETE/zones/{zone_id}/email/sending/subdomains/{subdomain_id}
ModelsExpand Collapse
class SubdomainListResponse: …
email_sending_enabled: bool

Whether Email Sending is enabled on this subdomain.

name: str

The subdomain domain name.

tag: str

Sending subdomain identifier.

maxLength32
created: Optional[datetime]

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector: Optional[str]

The DKIM selector used for email signing.

email_sending_return_path_domain: Optional[str]

The return-path domain used for bounce handling.

enabled: Optional[bool]

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

modified: Optional[datetime]

The date and time the destination address was last modified.

formatdate-time
class SubdomainGetResponse: …
email_sending_enabled: bool

Whether Email Sending is enabled on this subdomain.

name: str

The subdomain domain name.

tag: str

Sending subdomain identifier.

maxLength32
created: Optional[datetime]

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector: Optional[str]

The DKIM selector used for email signing.

email_sending_return_path_domain: Optional[str]

The return-path domain used for bounce handling.

enabled: Optional[bool]

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

modified: Optional[datetime]

The date and time the destination address was last modified.

formatdate-time
class SubdomainCreateResponse: …
email_sending_enabled: bool

Whether Email Sending is enabled on this subdomain.

name: str

The subdomain domain name.

tag: str

Sending subdomain identifier.

maxLength32
created: Optional[datetime]

The date and time the destination address has been created.

formatdate-time
email_sending_dkim_selector: Optional[str]

The DKIM selector used for email signing.

email_sending_return_path_domain: Optional[str]

The return-path domain used for bounce handling.

enabled: Optional[bool]

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

modified: Optional[datetime]

The date and time the destination address was last modified.

formatdate-time
class SubdomainDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

SubdomainsDNS

Get sending subdomain DNS records
email_sending.subdomains.dns.get(strsubdomain_id, DNSGetParams**kwargs) -> SyncSinglePage[DNSRecord]
GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns