Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Mailboxes

Update Mailbox

API key access

Needs the mailboxes:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PATCH/api/v1/mailboxes/{mailbox_id}

Authorization

AuthorizationBearer <token>

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

mailbox_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

daily_send_cap?integer | null
Formatint64
Range0 < value <= 10000

Response Body

curl -X PATCH "http://localhost:8000/api/v1/mailboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "provider": "unipile",
  "service": "google",
  "email_address": "string",
  "display_name": "string",
  "status": "connected",
  "daily_send_cap": 0,
  "connected_by_user_id": "b6d751ce-d9fb-4fe5-aed1-d42f5449f910",
  "connected_at": "2019-08-24T14:15:22Z",
  "disconnected_at": "2019-08-24T14:15:22Z",
  "last_health_check_at": "2019-08-24T14:15:22Z",
  "last_error": "string",
  "last_inbound_at": "2019-08-24T14:15:22Z",
  "last_sent_at": "2019-08-24T14:15:22Z",
  "paused_at": "2019-08-24T14:15:22Z",
  "pause_reason": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

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.

Export My Data

Download everything ReachOut keeps about you as an account (RO-295): profile, workspace memberships, sign-in sessions, API keys you created, apps you connected, invitations you sent or accepted and your personal notifications. No passwords, tokens, keys or their hashes. Signed-in users only: an API key gets 403.