Skip to content

by Startups.Studio

Growth Channel Mailbox

Mailbox.create

POST /{namespace}/mailboxes

Creates a Mailbox.

Noun: Mailbox
Mode: do
Event: Mailbox.created

You, to your agent

Add a mailbox to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/mailboxes \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email","address":"mei@quietcopy.com","stream":"transactional"}'

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.create({ medium: 'email', address: 'mei@quietcopy.com', stream: 'transactional' })

npx startup-builder do Mailbox.create --json '{"medium":"email","address":"mei@quietcopy.com","stream":"transactional"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Mailbox.create({ medium: 'email', address: 'mei@quietcopy.com', stream: 'transactional' })"
  }
}

Create makes a new Mailbox from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`medium`	`string`	required	The platform type, such as `email`, `sms`, or `chat`.
`organization`	Organization		The outside Organization the Channel is shared with; its new Messages open Conversations for that Customer.
`external`	`boolean`		True when people from another Organization post in it, as in a channel two companies share.
`areaCode`	`string`		For an `sms` Channel, the phone area code its number is drawn from, such as `512`.
`number`	`string`		For an `sms` Channel, its phone number in international form, assigned when it is created.
`address`	`email`	required	The email address.
`stream`	`string`	required	What it sends: receipts and resets, broadcasts, or cold outbound; one stream per Mailbox.
`tenant`	Tenant		The Tenant it sends for, at a Domain that Tenant’s Customer holds; replies land in the Tenant’s Threads.

Outputs

Output	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox.

Effects

Emits Mailbox.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Mailbox.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Mailbox

Previous Page

Mailbox.get

Next Page