Mailboxes

Remove an address from a mailbox

Removes an address from a mailbox and returns the mailbox.

DELETE
/v1/mailboxes/{id}/addresses/{addressId}

Removes an address from a mailbox and returns the mailbox. Mail sent to the address stops reaching the mailbox; its existing threads and messages stay. A mailbox keeps at least one address, so removing the last one is refused (422). When the removed address was the default From, the mailbox sends from its oldest remaining address, without a sender name of its own.

x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
addressId*string
Match^mbxaddr_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/mailboxes/string/addresses/string"
{  "id": "string",  "namespaceId": "string",  "slug": "string",  "name": "string",  "status": "active",  "primaryAddress": "string",  "createdAt": "string",  "description": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "addresses": [    {      "id": "string",      "address": "string",      "source": "samvaHosted",      "domainId": "string",      "displayName": "string"    }  ],  "defaultFrom": {    "address": "string",    "displayName": "string"  },  "updatedAt": "string"}

Related documentation