Remove an endpoint from a mailbox
Removes an endpoint from a mailbox and returns the mailbox.
DELETE
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.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$endpointId*stringMatch
^mbxep_[0-9a-hjkmnp-tv-z]{16,24}$Mailbox
application/json- response
id*MailboxIdMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$kind*MailboxKindWhether a mailbox belongs to one person or is shared with a team.
Value in
"personal""shared"owner*|nullnamespaceId*|nullslug*stringname*stringstatus*MailboxStatusValue in
"active""paused"primaryAddress*string|nullsendingStatus*|nullcreatedAt*stringdescription*string|nullmetadata*endpoints*array<||>updatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.mailboxes.removeEndpoint({
"id": "example",
"endpointId": "example"
});Example Response
{
"id": "string",
"kind": "personal",
"owner": "string",
"namespaceId": "string",
"slug": "string",
"name": "string",
"status": "active",
"primaryAddress": "string",
"sendingStatus": "pending",
"createdAt": "string",
"description": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"endpoints": [
{
"id": "string",
"address": "string",
"displayName": "string",
"default": true,
"channel": "email",
"source": "samvaHosted",
"domainId": "string",
"sendingStatus": "pending"
}
],
"updatedAt": "string"
}