Mailboxes

Add an endpoint to a mailbox

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: an email address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, a phone number must be one the organization connected on that channel, 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.

post/v1/mailboxes/{id}/endpoints

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/mailboxes/{id}/endpoints
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

channel'email' required

The channel an endpoint, thread, or message belongs to.

addressstring required
displayNamestring nullable

Response

Success

idstring required
namespaceIdstring required
slugstring required
namestring required
status'active' | 'paused' required
primaryAddressstring nullable required
createdAtstring required
descriptionstring nullable required
metadataMailboxMetadata required
updatedAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.