Skip to main content
PATCH
Update workspace mailbox

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json

PATCH the workspace outbound mailbox: change its localpart (the address all agents send from). The localpart edit renames tenants.outbound_mailbox_localpart AND the system endpoint's localpart in one transaction.

The workspace mailbox is fire-and-notify ONLY: it never auto-replies. A reply to it always files to the Review queue + notifies the initiator, so reply_policy is fixed to never_reply and is NOT configurable here (an address that answers mail is a custom inbox, created via create_endpoint). The only knob is the address.

court_intake_enabled
boolean | null

Court-document intake on/off for the team mailbox (the address court secure-mail typically lands on). Omitted = keep current. See docs/court-document-intake.md.

court_secure_mail_password
string | null

Secure-mail password for the court portal. WRITE-ONLY: vault-sealed when non-empty, never echoed back. Omitted/empty = keep the stored password.

localpart
string | null

Response

Workspace mailbox localpart updated