Mailboxes

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
/v1/mailboxes/{id}

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}.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

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

Request Body

application/json
  1. body
name?|null
metadata?|null

Response Body

Mailbox

application/json
  1. response
id*MailboxId
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
kind*MailboxKind

Whether a mailbox belongs to one person or is shared with a team.

Value in"personal""shared"
owner*|null
namespaceId*|null
slug*string
name*string
status*MailboxStatus
Value in"active""paused"
primaryAddress*string|null
createdAt*string
description*string|null
metadata*
endpoints*array<||>
updatedAt*string
Example Request
import { 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",  "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