--- title: Update an email domain --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Email Security](https://developers.cloudflare.com/api/typescript/resources/email_security) [Settings](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings) [Domains](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update an email domain client.emailSecurity.settings.domains.edit(stringdomainID, DomainEditParams {account\_id, allowed\_delivery\_modes, drop\_dispositions, 8 more } params, RequestOptionsoptions?): [DomainEditResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } PATCH/accounts/{account\_id}/email-security/settings/domains/{domain\_id} Updates configuration for a protected email domain. Only provided fields will be modified. Changes affect delivery mode, security settings, and regional processing. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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

##### Accepted Permissions (at least one required) `Cloud Email Security: Write` ##### ParametersExpand Collapse domainID: string Domain identifier. formatuuid [Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20domain_id%20%3E%20(schema)>)

params: DomainEditParams {account\_id, allowed\_delivery\_modes, drop\_dispositions, 8 more }

account\_id: string Path param: Identifier. maxLength32 Link to this property

allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> Body param: Delivery modes to onboard the domain through.

One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property

Link to this property

drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> Body param: Dispositions to drop instead of delivering, e.g. ["MALICIOUS", "SPAM"].

One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property

Link to this property

folder?: "AllItems"| "Inbox"| null Body param: The mailbox folder to scan, for API-scanning domains.

One of the following: "AllItems" Link to this property "Inbox" Link to this property

Link to this property integration\_id?: string| null Body param: Identifier of the CASB integration that authorizes this domain. The integration also enables API scanning, post-delivery actions, and directory sync. formatuuid Link to this property ip\_restrictions?: Array<string> Body param: Source IP ranges mail is accepted from. Any other source is rejected. Link to this property lookback\_hops?: number Body param: Number of hops to trace back through received headers when reconstructing the original message (1-20). maximum20 minimum1 Link to this property

regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> Body param: Regions that process messages for this domain, e.g. ["GLOBAL"] or ["US"].

One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property

Link to this property require\_tls\_inbound?: boolean Body param: Require TLS on inbound connections. Link to this property require\_tls\_outbound?: boolean Body param: Require TLS on outbound connections. Link to this property transport?: string Body param: The mail transport hostname for MX/Inline delivery — the MX record Cloudflare delivers email to (e.g. mx.example.com). Link to this property

[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(method)%20edit%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

DomainEditResponse {id, allowed\_delivery\_modes, authorization, 19 more }

id?: string Domain identifier. formatuuid Link to this property

allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more>

One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property

Link to this property

authorization?: Authorization| null

authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property

Link to this property created\_at?: string formatdate-time Link to this property

dmarc\_status?: "none"| "good"| "invalid"| null

One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property

Link to this property domain?: string Link to this property

drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more>

Link to this property

emails\_processed?: EmailsProcessed| null

timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property

Link to this property

folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains.

One of the following: "AllItems" Link to this property "Inbox" Link to this property

Link to this property

inbox\_provider?: "Microsoft"| "Google"| null

One of the following: "Microsoft" Link to this property "Google" Link to this property

Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property

regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more>

One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property

Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property

spf\_status?: "none"| "good"| "neutral"| 2 more| null

One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property

Link to this property

status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null

One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property

Link to this property transport?: string Link to this property

[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_edit_response%20%3E%20(schema)>) ### Update an email domain TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.emailSecurity.settings.domains.edit( 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415', { account_id: '023e105f4ecef8ad9ca31a8372d0c353' }, ); console.log(response.id); ``` 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": { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "allowed_delivery_modes": [ "DIRECT" ], "authorization": { "authorized": true, "timestamp": "2019-12-27T18:11:19.117Z", "status_message": "status_message" }, "created_at": "2014-01-01T05:20:00.12345Z", "dmarc_status": "none", "domain": "example.com", "drop_dispositions": [ "MALICIOUS" ], "emails_processed": { "timestamp": "2019-12-27T18:11:19.117Z", "total_emails_processed": 0, "total_emails_processed_previous": 0 }, "folder": "AllItems", "inbox_provider": "Microsoft", "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "ip_restrictions": [ "192.0.2.0/24", "2001:db8::/32" ], "last_modified": "2014-01-01T05:20:00.12345Z", "lookback_hops": 0, "modified_at": "2014-01-01T05:20:00.12345Z", "o365_tenant_id": "o365_tenant_id", "regions": [ "GLOBAL" ], "require_tls_inbound": true, "require_tls_outbound": true, "spf_status": "none", "status": "PENDING", "transport": "transport" } } ``` ##### 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": { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "allowed_delivery_modes": [ "DIRECT" ], "authorization": { "authorized": true, "timestamp": "2019-12-27T18:11:19.117Z", "status_message": "status_message" }, "created_at": "2014-01-01T05:20:00.12345Z", "dmarc_status": "none", "domain": "example.com", "drop_dispositions": [ "MALICIOUS" ], "emails_processed": { "timestamp": "2019-12-27T18:11:19.117Z", "total_emails_processed": 0, "total_emails_processed_previous": 0 }, "folder": "AllItems", "inbox_provider": "Microsoft", "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "ip_restrictions": [ "192.0.2.0/24", "2001:db8::/32" ], "last_modified": "2014-01-01T05:20:00.12345Z", "lookback_hops": 0, "modified_at": "2014-01-01T05:20:00.12345Z", "o365_tenant_id": "o365_tenant_id", "regions": [ "GLOBAL" ], "require_tls_inbound": true, "require_tls_outbound": true, "spf_status": "none", "status": "PENDING", "transport": "transport" } } ```