Mailboxes

Remove an endpoint from a mailbox

Removes an endpoint from a mailbox and returns the mailbox.

DELETE
/v1/mailboxes/{id}/endpoints/{endpointId}

Removes an endpoint from a mailbox and returns the mailbox. Messages sent to it stop reaching the mailbox; its existing threads and messages stay, and replies in them leave from the mailbox's default endpoint on their channel. A mailbox keeps at least one endpoint, so removing the last one is refused (422). When the removed endpoint was the default on its channel, the oldest remaining endpoint there becomes the default.

x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
endpointId*string
Match^mbxep_[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/endpoints/string"
{  "id": "string",  "namespaceId": "string",  "slug": "string",  "name": "string",  "status": "active",  "primaryAddress": "string",  "createdAt": "string",  "description": "string",  "metadata": {    "property1": "string",    "property2": "string"  },  "endpoints": [    {      "id": "string",      "address": "string",      "displayName": "string",      "default": true,      "channel": "email",      "source": "samvaHosted",      "domainId": "string"    }  ],  "updatedAt": "string"}

Related documentation