AI Inbox

Add Mailbox To Workspace

Put a mailbox into a workspace.

IDEMPOTENT: adding a mailbox that is already a member is a no-op, and the response says which happened rather than failing.

This one handler wants a PropelAuthUser rather than the shared principal, so it gets one from build_api_principal - resolved from the validated key, never client-supplied.

post/inbox/workspaces/{workspace_id}/mailboxes

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/inbox/workspaces/{workspace_id}/mailboxes
  • Auth: HTTP bearer

Path parameters

workspace_idstring required

Workspace id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

mailbox_idinteger required

Integer mailboxes.id - the database primary key, NOT the cron-job string id. The app is explicit about the difference and so is this.

Response

Successful Response

dataInboxPayload required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

Changes

No recorded changes to this operation across all 2 revisions of this API.