Update a mailbox endpoint
Updates the fields you name and keeps the rest, and returns the mailbox.
PATCH
Updates the fields you name and keeps the rest, and returns the mailbox. displayName is the name messages sent from the endpoint carry; null falls back to the mailbox's name. default: true makes the endpoint the one the mailbox starts new conversations from on its channel; replies always leave from the endpoint of their thread.
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}$application/json- body
displayName?|null|nulldefault?|nullMailbox
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.updateEndpoint({
"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"
}