Create a mailbox
Creates a mailbox with its addresses and returns it with status 201; the caller gets an admin grant on it.
Creates a mailbox with its addresses and returns it with status 201; the caller gets an admin grant on it. Each address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled. The mailbox receives mail from now on; mail that arrived earlier is not added to it. Conflicts if an address or slug is already in use. Returns 402 when the organization is at its plan's mailbox allowance or at its mailbox storage allowance; incoming mail is still received past the storage allowance.
Authorization
apiKey In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= itemsResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/mailboxes" \ -H "Content-Type: application/json" \ -d '{ "displayName": "string", "slug": "string", "addresses": [ { "address": "string" } ] }'{ "id": "string", "namespaceId": "string", "slug": "string", "displayName": "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"}