Mailboxes
Add an address to a mailbox
Adds an address to a mailbox and returns the mailbox with status 201.
Adds an address to a mailbox and returns the mailbox with status 201. The address follows the same rules as the address of a new mailbox: it must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and no mailbox may already hold it (409). Mail sent to it reaches the mailbox from now on; the mailbox keeps sending from its current default address until you change defaultFrom.
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.
address*string
displayName?string|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/mailboxes/string/addresses" \ -H "Content-Type: application/json" \ -d '{ "address": "string" }'{ "id": "string", "namespaceId": "string", "slug": "string", "name": "string", "status": "active", "primaryAddress": "string", "createdAt": "string", "description": "string", "metadata": { "property1": "string", "property2": "string" }, "addresses": [ { "id": "string", "address": "string", "source": "samvaHosted", "domainId": "string", "displayName": "string" } ], "defaultFrom": { "address": "string", "displayName": "string" }, "updatedAt": "string"}