Change an address's label, routing, or whether it accepts mail

PATCH

/admin/email/addresses/{id}

Not the address itself — mail is matched against it and a routing rule
at Cloudflare names it. Add a new one and switch the old one off.
active: false makes the Worker reject mail for it with a permanent
error rather than file it. Audited.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The address, and whether anything changed

Bodyapplication/json

🟠400

🟠403AdminOnly

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.prod-orm.io/admin/email/addresses/' \
--header 'Content-Type: application/json' \
--data '{
    "label": "string",
    "routesTo": [
        0
    ],
    "active": true
}'

Response Example

200 - Example 1

{
    "address": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "address": "user@example.com",
        "label": "string",
        "routesTo": [
            0
        ],
        "active": true,
        "ownerId": 0,
        "routing": {
            "managed": true,
            "ruleTag": "string",
            "error": "string"
        },
        "createdBy": 0,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "counts": {
            "unread": 0,
            "read": 0,
            "archived": 0,
            "spam": 0
        }
    },
    "changed": true
}

Modified at 2026-10-05 04:04:32

One address, with its counts

Remove an address that holds no mail