Skip to content

by Startups.Studio

Growth Channel Mailbox

Mailbox.warm

POST /{namespace}/mailboxes/{mailbox}/warm

Warm ramps a new Mailbox from a few sends a day to its cap over two to four weeks.

Noun: Mailbox
Mode: do
Event: Mailbox.warmed

You, to your agent

Warm my mailbox.

curl -X POST https://api.sb/ledgerlark.com/mailboxes/mailbox_1/warm \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cap":1}'

import { $ } from 'startup-builder'

const mailbox = await $.Mailbox.warm({ mailbox: 'mailbox_1', cap: 1 })

npx startup-builder do Mailbox.warm --json '{"mailbox":"mailbox_1","cap":1}'

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

Inputs

Input	Type	Required	Description
`mailbox`	Mailbox	required	The new Mailbox.
`cap`	`integer`	required	The daily sends it ramps to.

Outputs

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

Effects

Emits Mailbox.warmed.
Performed by the Customer Lead.
Two-way: it runs at once, in the try, send and do modes.
Raises the daily cap on a schedule while the spam rate stays under 0.1 percent.

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

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

Previous Page

Contact

Next Page