Remove an address
Removes the address. It stops receiving, anyone it was shared with loses it, and a sign-in set up for it stops working. Mail it already received stays in the mailbox.
Runs the real call on your workspace.
DELETE /domains/{id}/addresses/{addressId}
Removes the address. It stops receiving, anyone it was shared with loses it, and a sign-in set up for it stops working. Mail it already received stays in the mailbox.
Example
Needs domains:write. A key limited to particular addresses or domains needs to hold the whole domain.
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18" -H "$AUTH"{ "object": "address", "id": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18", "address": "[email protected]", "deleted": true}A removed address bounces its mail even while the catch-all is on, so the catch-all never picks it up. Create it again to take mail at it.
An OAuth access token of a member also needs workspace:manage in that member’s role, the permission the app asks for to remove an address. It is console-only, so without it the call is insufficient_authority, a 403, whatever the app was given.
An OAuth access token needs a verification code for this call. Until the app has verified one in the last 60 minutes, the call answers 403 step_up_required and changes nothing. An API key is never asked. The Authentication page shows how to ask for a code and verify it.