Skip to content

by Startups.Studio

Growth Channel Mailbox

Mailbox.rest

POST /{namespace}/mailboxes/{mailbox}/rest

Rest pauses a Mailbox’s sending when a brake fires and resumes it when the reading clears.

Noun: Mailbox
Mode: do
Event: Mailbox.rested

You, to your agent

Rest my mailbox.

curl -X POST https://api.sb/kilnbakery.com/mailboxes/mailbox_1/rest \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason":"complaints"}'

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.rest({ mailbox: 'mailbox_1', reason: 'complaints' })

npx startup-builder do Mailbox.rest --json '{"mailbox":"mailbox_1","reason":"complaints"}'

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

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The Mailbox to pause.
`reason`	`string`	required	The brake that fired.

Outputs

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

Effects

Emits Mailbox.rested.
Performed by the Customer Lead.
Two-way: it runs at once, in the try, send and do modes.
Fires on its own above 0.1 percent complaints or 2 percent bounces; a brake never waits.
A blocklisted Domain also opens an Incident.

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

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

Previous Page

Mailbox.retire

Next Page