API
Update an address
Renames the address in the app, or turns it off and on. A field left out keeps its value.
PATCH/domains/{id}/addresses/{addressId}
Runs the real call against your workspace, with your own key.
PATCH /domains/{id}/addresses/{addressId}
Renames the address in the app, or turns it off and on. A field left out keeps its value.
The request
Parameters
labelstring | null- A new name, at most 120 characters. `null` or an empty string clears it.
enabledboolean- Whether the address takes mail. A disabled address bounces mail at SMTP time, so the sender gets a bounce rather than silence.
Example
Needs domains:write. A key limited to particular addresses or domains needs to hold the whole domain.
curl -X PATCH "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18" -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "enabled": false }'{ "object": "address", "id": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f", "address": "[email protected]", "localPart": "billing", "label": "Invoices", "enabled": false, "lastReceivedAt": null, "createdAt": "2026-09-25T10:00:00.000Z", "updatedAt": "2026-09-25T10:00:00.000Z"}
