Update Fleet Mailbox
Admin+: a mailbox's rotation weight (0-100; 0 starts no new conversations) and its own warmup schedule (`warmup_days` 0-365, 0 = no ramp; `warmup_start_per_day`; `null` = the server's default; `restart_warmup` starts the ramp again today). 422 with the reason when invalid. Answers the mailbox's fleet entry.
API key access
admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/deliverability/fleet/mailboxes/{mailbox_id}Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
uuidHeader Parameters
Id of the workspace to act on (must be a member).
0-100 (0: starts no new conversations).
int320 <= value <= 1000-365 days (0: no ramp; null: the server's default).
int320 <= value <= 3651-10000 (null: the server's default).
int321 <= value <= 10000Start the ramp again today.
Response Body
curl -X PATCH "http://localhost:8000/api/v1/deliverability/fleet/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{}'{
"mailbox_id": "4d23d1af-2eef-4598-a5e0-1f19ae0b0c14",
"email_address": "string",
"domain": "string",
"status": "connected",
"paused_at": "2019-08-24T14:15:22Z",
"pause_reason": "string",
"score": 0,
"level": "healthy",
"issues": [
"string"
],
"rotation_weight": 0,
"in_rotation": true,
"daily_send_cap": 0,
"today_cap": 0,
"sent_today": 0,
"warmup": {
"days": 0,
"start_per_day": 0,
"started_at": "2019-08-24T14:15:22Z",
"custom": true,
"warming_up": true,
"day": 0,
"progress_percent": 0,
"ends_at": "2019-08-24T14:15:22Z",
"schedule": [
0
]
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Send Mailbox Email
Send a one-off email from a connected mailbox to a lead (manual follow-ups and replies). Enforced in code, exactly like the sequence runner's sends: the lead's email must not be on the suppression list and `can_contact(email, purpose)` must allow it (409 `Sending is not allowed: <reasons>`), the mailbox must be connected, not paused by the deliverability guard and under its daily cap (409). A marketing send held back by the contact-pressure rules (a manual touch: exempt while the lead is in a conversation with us) or a resource rate limit is a 409 with `code` `contact_deferred`, the `reasons` and `next_allowed_at`. A `marketing` email (the default) gets one-click `List-Unsubscribe` headers (RFC 8058) and the CAN-SPAM footer with the workspace's postal address (409 `missing_postal_address` without one). The send is logged and appended to the lead's timeline (`email_sent`, by the caller). `reply_to_message_id` threads the email under a provider message (e.g. the lead's reply).
Update Mailbox
Next Page