Mailboxes
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.
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 x-api-key<token>
In: header
Path Parameters
id*string
Match
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name?|null
metadata?|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/mailboxes/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}