Add an endpoint to a mailbox
Adds an endpoint to a mailbox and returns the mailbox with status 201.
POST
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.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
channel*MailboxChannelThe channel an endpoint, thread, or message belongs to.
Value in
"sms""whatsapp""email"address*stringdisplayName?|nullSuccess
application/json- response
id*MailboxIdMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$kind*MailboxKindWhether a mailbox belongs to one person or is shared with a team.
Value in
"personal""shared"owner*|nullnamespaceId*|nullslug*stringname*stringstatus*MailboxStatusValue in
"active""paused"primaryAddress*string|nullsendingStatus*|nullcreatedAt*stringdescription*string|nullmetadata*endpoints*array<||>updatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.mailboxes.createEndpoint({
"id": "example",
"channel": "sms",
"address": "example"
});Example Response
{
"id": "string",
"kind": "personal",
"owner": "string",
"namespaceId": "string",
"slug": "string",
"name": "string",
"status": "active",
"primaryAddress": "string",
"sendingStatus": "pending",
"createdAt": "string",
"description": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"endpoints": [
{
"id": "string",
"address": "string",
"displayName": "string",
"default": true,
"channel": "email",
"source": "samvaHosted",
"domainId": "string",
"sendingStatus": "pending"
}
],
"updatedAt": "string"
}