Mailbox methods: update · StartupBuilder

Reference for Mailbox, one group of Mailbox methods.

Mailbox.update

Changes the given properties of a Mailbox. Verb page.

TypeScript

interface MailboxVerbs {
  update(input: MailboxUpdateInput, options?: SB.CallOptions): SB.Call<Mailbox>
}

Emits Mailbox.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Mailbox.
`medium`	`string`		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`		The email address.
`stream`	`string`		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.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.update({ id: 'mailbox_93HvOnR17L', address: 'dana@leaseline.app' })