Skip to content

by Startups.Studio

Growth Channel Mailbox

Mailbox.retire

POST /{namespace}/mailboxes/{mailbox}/retire

Retire stops a Mailbox for good and keeps its address, Messages and sending history.

Noun: Mailbox
Mode: do
Event: Mailbox.retired

You, to your agent

Retire my mailbox.

curl -X POST https://api.sb/patentpad.com/mailboxes/mailbox_1/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.retire({ mailbox: 'mailbox_1' })

npx startup-builder do Mailbox.retire --json '{"mailbox":"mailbox_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Mailbox.retire({ mailbox: 'mailbox_1' })"
  }
}

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox to retire.

Outputs

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

Effects

Emits Mailbox.retired.
Performed by the Customer Lead.
One-way: it waits out its delay window, and runs in the send and do modes.
Routes new mail to the Mailbox of the Role it served.

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

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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.rest

Previous Page

Mailbox.update

Next Page