Topolo Docs Topolo Platform
Open workspace

Bind mailbox to seat

Bind a connected Nexus mailbox sender (mailboxId, mbsender_…, from the connect return URL's mailbox_id) to a seat, read its status from Nexus and lift a pause the previous mailbox caused (misconfigured, not allowed, needs re-auth, unavailable). The seat sends from this mailbox from the next run. Verify with seats.get; roll back by binding the previous mailbox id.

Outcome

Bind a connected Nexus mailbox sender (mailboxId, mbsender_…, from the connect return URL's mailbox_id) to a seat, read its status from Nexus and lift a pause the previous mailbox caused (misconfigured, not allowed, needs re-auth, unavailable). The seat sends from this mailbox from the next run. Verify with seats.get; roll back by binding the previous mailbox id.

Before you start

  • Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:write.
  • Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.
  • Review the exact effects and obtain approval before CLI --confirm or MCP confirm:true. A local capture does not authorize a live mutation.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.seats.bind_mailbox --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

FieldRequiredDeclared constraints
idYes{"type":"string","minLength":1,"maxLength":128}
mailboxIdYes{"type":"string","pattern":"^mbsender_[A-Za-z0-9_-]{1,120}$"}

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.seats.bind_mailbox --data @payload.json --json
topolo actions plan app_topolo_engage.seats.bind_mailbox --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

Review the plan and approve its exact effects before executing the unchanged request.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.seats.bind_mailbox --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --confirm --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · sender health enforcement > leaves a seat under the minimum volume, and never rewrites a manual pause

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > leaves a seat under the minimum volume, and never rewrites a manual pause. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > leaves a seat under the minimum volume, and never rewrites a manual pause

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "b@other.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > leaves a seat under the minimum volume, and never rewrites a manual pause. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Bea",
    "fromAddress": "bea@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · the run ledger > records a scheduled pass: the heartbeat and one row per workspace touched

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: the run ledger > records a scheduled pass: the heartbeat and one row per workspace touched. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "a@one.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "b@two.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue

Action input

{
  "id": "eng_seat_3",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_3",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "c@three.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses on complaints, a soft-bounce streak and a mailbox issue. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses every seat on a breaching sending domain

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "a@shared.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses every seat on a breaching sending domain. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses every seat on a breaching sending domain

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "b@shared.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses every seat on a breaching sending domain. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · sender health enforcement > pauses every seat on a breaching sending domain

Action input

{
  "id": "eng_seat_3",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_3",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "c@other.io",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: sender health enforcement > pauses every seat on a breaching sending domain. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · the run ledger > records holds by reason

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 1,
      "dailyIncrease": 3,
      "maxLimit": 1
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 1
    }
  }
}

Source test: the run ledger > records holds by reason. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · runDueSends > hold order > then the recipient-local window, then the warm-up cap

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-12-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 0
    }
  }
}

Source test: runDueSends > hold order > then the recipient-local window, then the warm-up cap. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · runner with the Nexus transport contract > outreach_requires_mailbox_sender marks the seat misconfigured, pauses it and holds

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_2"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_2",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T09:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T09:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: runner with the Nexus transport contract > outreach_requires_mailbox_sender marks the seat misconfigured, pauses it and holds. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · runDueSends > seat health auto-pause > pauses a seat over the bounce limit and resumes it once the 14-day window recovers

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 100,
      "dailyIncrease": 3,
      "maxLimit": 100
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 100
    }
  }
}

Source test: runDueSends > seat health auto-pause > pauses a seat over the bounce limit and resumes it once the 14-day window recovers. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · render ahead for approval > queues a message due tomorrow today, sends it in the window once approved, and never renders twice

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-05T09:00:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-05T09:00:00.000Z",
    "updatedAt": "2026-10-05T09:00:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 22
    }
  }
}

Source test: render ahead for approval > queues a message due tomorrow today, sends it in the window once approved, and never renders twice. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · seat mailbox actions > connects and reads mailboxes only as the signed-in person: without their token it refuses before calling Nexus

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_x"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_x",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: seat mailbox actions > connects and reads mailboxes only as the signed-in person: without their token it refuses before calling Nexus. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · seat mailbox actions > binds the mailbox the OAuth return names, reading its status

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_google_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_1",
    "nexusMailboxId": "mbsender_google_1",
    "mailboxStatus": "needs_reauth",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "ash@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: seat mailbox actions > binds the mailbox the OAuth return names, reading its status. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · ops.health.get > snapshots the pipeline of this workspace only

Action input

{
  "id": "eng_seat_2",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "seat": {
    "id": "eng_seat_2",
    "nexusMailboxId": "mbsender_1",
    "mailboxStatus": "active",
    "mailboxCheckedAt": "2026-10-06T08:30:00.000Z",
    "whatsappConnectionId": null,
    "displayName": "Ash",
    "fromAddress": "b@example.com",
    "status": "active",
    "pauseReason": null,
    "timezone": "Europe/London",
    "warmup": {
      "startDate": "2026-10-01",
      "startLimit": 10,
      "dailyIncrease": 3,
      "maxLimit": 50
    },
    "createdAt": "2026-10-06T08:30:00.000Z",
    "updatedAt": "2026-10-06T08:30:00.000Z",
    "health": {
      "windowDays": 14,
      "sent": 0,
      "bounced": 0,
      "optedOut": 0,
      "bounceRate": 0,
      "optOutRate": 0,
      "healthy": true,
      "sentToday": 0,
      "warmupCap": 25
    }
  }
}

Source test: ops.health.get > snapshots the pipeline of this workspace only. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

  • Bind a connected Nexus mailbox sender (mailboxId, mbsender_…, from the connect return URL's mailbox_id) to a seat, read its status from Nexus and lift a pause the previous mailbox caused (misconfigured, not allowed, needs re-auth, unavailable). The seat sends from this mailbox from the next run. Verify with seats.get; roll back by binding the previous mailbox id.

Verify the outcome

  • Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 401 · seat mailbox actions > connects and reads mailboxes only as the signed-in person: without their token it refuses before calling Nexus

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_x"
}

Actual local response

{
  "error": {
    "code": "user_credential_required",
    "message": "Connect a mailbox while signed in as the person it belongs to."
  }
}

Source test: seat mailbox actions > connects and reads mailboxes only as the signed-in person: without their token it refuses before calling Nexus. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · seat mailbox actions > binds the mailbox the OAuth return names, reading its status

Refused input; do not execute

{
  "mailboxId": "profile_1",
  "id": "eng_seat_1"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for seats.bind_mailbox is invalid.",
    "details": [
      {
        "origin": "string",
        "code": "invalid_format",
        "format": "regex",
        "pattern": "/^mbsender_[A-Za-z0-9_-]{1,120}$/",
        "path": [
          "mailboxId"
        ],
        "message": "Use a Nexus mailbox sender id (mbsender_…)."
      }
    ]
  }
}

Source test: seat mailbox actions > binds the mailbox the OAuth return names, reading its status. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 404 · seat mailbox actions > binds the mailbox the OAuth return names, reading its status

Action input

{
  "id": "eng_seat_9",
  "mailboxId": "mbsender_x"
}

Actual local response

{
  "error": {
    "code": "not_found",
    "message": "Seat was not found in this workspace."
  }
}

Source test: seat mailbox actions > binds the mailbox the OAuth return names, reading its status. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 403 · seat mailbox actions > binds the mailbox the OAuth return names, reading its status

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_x"
}

Actual local response

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:write.",
    "details": {
      "requiredPermission": "workspace:write"
    }
  }
}

Source test: seat mailbox actions > binds the mailbox the OAuth return names, reading its status. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 424 · seat mailbox actions > 424s without a mailbox directory and 502s when Nexus is down

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "error": {
    "code": "mailbox_directory_not_configured",
    "message": "This deploy has no Nexus mailbox connection."
  }
}

Source test: seat mailbox actions > 424s without a mailbox directory and 502s when Nexus is down. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 502 · seat mailbox actions > 424s without a mailbox directory and 502s when Nexus is down

Action input

{
  "id": "eng_seat_1",
  "mailboxId": "mbsender_1"
}

Actual local response

{
  "error": {
    "code": "mailbox_directory_unavailable",
    "message": "Nexus could not be reached. Try again."
  }
}

Source test: seat mailbox actions > 424s without a mailbox directory and 502s when Nexus is down. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

  • HTTP 401 user_credential_required: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
  • HTTP 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.
  • HTTP 404 not_found: Rediscover the identifier using the related list or get action in the same authorized resource. Do not guess identifiers or change organization context.
  • HTTP 403 permission_denied: Stop and inspect the current credential and selected resource. It needs workspace:write; do not broaden access or switch organization automatically.
  • HTTP 424 mailbox_directory_not_configured: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
  • HTTP 502 mailbox_directory_unavailable: Preserve the request and inspect the declared dependency state. Retry only after the transient or configuration cause is resolved; do not infer that the operation completed.

Evidence and limits

  • /api/seats/{id}/mailbox

  • Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

  • Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

  • No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.