Update a mailbox
Update a mailbox. Updates the fields you name and keeps the rest. `metadata` merges into the stored metadata by key, and a `null` value deletes that key.
PATCH
Updates the fields you name and keeps the rest. metadata merges into the stored metadata by key, and a null value deletes that key. Change an endpoint's sender name or default with PATCH /v1/mailboxes/{id}/endpoints/{endpointId}.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
name?|nullmetadata?|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.update({
"id": "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"
}