Set active workspace

/api/v2/me/active-workspace

AUTHENTICATIONBearer token · workspaces:writeAUTHORITATIVE OWNERidentity-workspaceCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Identify a retired compatibility marker for workspace selection; it does not switch context.

WHEN THIS CALL IS USEFUL

Do not call or register this route. Use the implemented PUT /api/v2/me/active-workspace operation with workspace_id instead.

OUTCOME · Legacy marker

What changes

None. The route returns 501 and cannot select a workspace.

WHY IT MATTERS

Makes legacy method mismatch explicit so integrations migrate to one canonical selection contract.

ISOLATION + AUTHORITY

Because it is non-executable, it grants no context or authority.

BEFORE YOU CALL

No valid production use.

WHAT TO DO NEXT

Call PUT /api/v2/me/active-workspace with a workspace from GET /api/v2/workspaces.

AGENT GUIDANCE

Replace this method in generated tools and saved integrations with the implemented PUT operation.
Do not retry a 501 or interpret it as a temporary workspace outage.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the workspaces:write scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

501Non-executable legacy workspace compatibility marker.Not executable · JSON RESPONSE+

{
  "code": "planned_contract",
  "executable": false,
  "migration": "Use implemented PUT /api/v2/me/active-workspace with its exact workspace_uuid body."
}

INTEGRATION DECISIONplanned_contract

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from tenant-bound workspaces, memberships, invitations, roles, preferences, revisions, and lifecycle receipts through an implemented operation.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

OPERATIONAL NOTES

Security and lifecycle guarantees

Do not call this bodyless marker. It performs no workspace selection, invitation, referral, membership revocation, or role change.
Use implemented PUT /api/v2/me/active-workspace with its exact workspace_uuid body.
Verify the implemented replacement in /api/v2/openapi.json and follow its exact parameter, version, role, and lockout contract.
Do not translate the legacy body field-for-field or submit caller-selected tenant, owner, actor, authority, or cross-workspace selectors.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/workspaces/activateWORKSPACE: Set Active Workspace

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗