---
title: Update a sending subdomain
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/python)

[Email Sending](https://developers.cloudflare.com/api/python/resources/email%5Fsending)

[Subdomains](https://developers.cloudflare.com/api/python/resources/email%5Fsending/subresources/subdomains)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Update a sending subdomain

email\_sending.subdomains.edit(strsubdomain\_id, SubdomainEditParams\*\*kwargs)  \-> [SubdomainEditResponse](https://developers.cloudflare.com/api/python/resources/email%5Fsending#%28resource%29%20email%5Fsending.subdomains%20%3E%20%28model%29%20subdomain%5Fedit%5Fresponse%20%3E%20%28schema%29)

PATCH/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id}

Updates the activity-log preview preference for a sending subdomain.

##### Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### ParametersExpand Collapse 

zone\_id: str

Identifier.

maxLength32

subdomain\_id: str

Sending subdomain identifier.

maxLength32

drop\_suppressed\_recipients: Optional\[[bool](https://developers.cloudflare.com/api/python/resources/email%5Fsending/subresources/subdomains/methods/edit#%28resource%29%20email%5Fsending.subdomains%20%3E%20%28method%29%20edit%20%3E%20%28params%29%20default%20%3E%20%28param%29%20drop%5Fsuppressed%5Frecipients%20%3E%20%28schema%29)\]

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.

preview\_enabled: Optional\[[bool](https://developers.cloudflare.com/api/python/resources/email%5Fsending/subresources/subdomains/methods/edit#%28resource%29%20email%5Fsending.subdomains%20%3E%20%28method%29%20edit%20%3E%20%28params%29%20default%20%3E%20%28param%29%20preview%5Fenabled%20%3E%20%28schema%29)\]

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

##### ReturnsExpand Collapse 

class SubdomainEditResponse: …

enabled: bool

Whether Email Sending is enabled on this subdomain.

name: str

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

tag: str

Sending subdomain identifier.

maxLength32

created: Optional\[datetime\]

The date and time the destination address has been created.

formatdate-time

dkim\_selector: Optional\[str\]

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

drop\_suppressed\_recipients: Optional\[bool\]

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\[datetime\]

The date and time the destination address was last modified.

formatdate-time

preview\_enabled: Optional\[bool\]

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

return\_path\_domain: Optional\[str\]

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

### Update a sending subdomain

Python

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
response = client.email_sending.subdomains.edit(
    subdomain_id="aabbccdd11223344aabbccdd11223344",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(response.enabled)
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "enabled": true,
    "name": "sub.example.com",
    "tag": "aabbccdd11223344aabbccdd11223344",
    "created": "2014-01-02T02:20:00Z",
    "dkim_selector": "cf-bounce",
    "drop_suppressed_recipients": false,
    "modified": "2014-01-02T02:20:00Z",
    "preview_enabled": true,
    "return_path_domain": "cf-bounce.sub.example.com"
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "enabled": true,
    "name": "sub.example.com",
    "tag": "aabbccdd11223344aabbccdd11223344",
    "created": "2014-01-02T02:20:00Z",
    "dkim_selector": "cf-bounce",
    "drop_suppressed_recipients": false,
    "modified": "2014-01-02T02:20:00Z",
    "preview_enabled": true,
    "return_path_domain": "cf-bounce.sub.example.com"
  }
}
```