Rotate this workspace's inbound email address
Revoke the current address and issue a new one.
/v1/channels/email/address/rotateAdmin- Operation id
- rotate_inbound_address
- Access
- An editor or a viewer is refused.
/v1/channels/email/address/rotateRevoke the current address and issue a new one.
The old address stops routing immediately. Mail sent to it is recorded in
the delivery ledger as address_inactive and creates nothing. Existing
tickets keep their history; what breaks is any customer thread whose stored
reply-to is the old address, which is the price of revocation and the reason
this is an admin operation.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/channels/email/address/rotate"{ "address": "string", "domain": "string", "minted": true}