Add an endpoint to a mailbox
Adds an endpoint to a mailbox and returns the mailbox with status 201.
Adds an endpoint to a mailbox and returns the mailbox with status 201. It follows the same rules as the endpoint of a new mailbox: email is the channel a mailbox endpoint uses today (422 otherwise), the address 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). Messages sent to it reach the mailbox from now on. It becomes the default on its channel only when the mailbox has no endpoint there yet.
Authorization
apiKey In: header
Path Parameters
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The channel an endpoint, thread, or message belongs to.
Value in
- "email"
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/endpoints" \ -H "Content-Type: application/json" \ -d '{ "channel": "email", "address": "string" }'{ "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"}