Revenue

Link workspace

Link workspace sends the sending workspace id and the organization id from the form. The stored workspace keeps those ids, switches to linked, and turns the sending check on.

post/v1/revenue-workspaces/link

Request

Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/revenue-workspaces/link
Auth: HTTP bearer

Request body

outboundOrganizationIdstring

Organization id.

outboundWorkspaceIdstring required

Sending workspace id.

Example request

{
  "outboundOrganizationId": "org_1",
  "outboundWorkspaceId": "ws_1"
}

Response

The linked workspace Link workspace stores.

idstring uuid required

Stable UUID primary key.

lastVerifiedAtstring date-time nullable

When the link was last verified.

mode'local' | 'linked' required

Workspace mode.

outboundOrganizationIdstring

OutboundConsole organization id.

outboundWorkspaceIdstring

OutboundConsole workspace id.

preflightAvailableboolean required

Whether policy preflight can run (linked and active).

status'active' | 'disconnected' | 'repair_required' required

Lifecycle/status slug. Subscription rows use billing states; background task runs use queued/running/succeeded/failed/stopped.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastVerifiedAt": "2026-07-12T12:00:00Z",
  "mode": "local",
  "outboundOrganizationId": "org_01ABC",
  "outboundWorkspaceId": "ws_01ABC",
  "status": "active"
}

Changes

No operation changes recorded.