--- title: Subdomains --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Email Sending](https://developers.cloudflare.com/api/typescript/resources/email_sending) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Subdomains ##### [List sending subdomains](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/list) client.emailSending.subdomains.list(SubdomainListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [SubdomainListResponse]() {enabled, name, tag, 6 more } > GET/zones/{zone\_id}/email/sending/subdomains ##### [Get a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/get) client.emailSending.subdomains.get(stringsubdomainID, SubdomainGetParams {zone\_id } params, RequestOptionsoptions?): [SubdomainGetResponse]() {enabled, name, tag, 6 more } GET/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id} ##### [Create a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/create) client.emailSending.subdomains.create(SubdomainCreateParams {zone\_id, name } params, RequestOptionsoptions?): [SubdomainCreateResponse]() {enabled, name, tag, 6 more } POST/zones/{zone\_id}/email/sending/subdomains ##### [Update a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/edit) client.emailSending.subdomains.edit(stringsubdomainID, SubdomainEditParams {zone\_id, drop\_suppressed\_recipients, preview\_enabled } params, RequestOptionsoptions?): [SubdomainEditResponse]() {enabled, name, tag, 6 more } PATCH/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id} ##### [Delete a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/delete) 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 {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: 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. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_list_response%20%3E%20(schema)>)
SubdomainGetResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: 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. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_get_response%20%3E%20(schema)>)
SubdomainCreateResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: 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. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_create_response%20%3E%20(schema)>)
SubdomainEditResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: 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. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_edit_response%20%3E%20(schema)>)
SubdomainDeleteResponse {errors, messages, success }
errors: Array<Error> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property
messages: Array<Message> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property success: true Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_delete_response%20%3E%20(schema)>) #### SubdomainsDNS ##### [Get sending subdomain DNS records](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/subresources/dns/methods/get) 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