Invite/refer a new user

/api/v2/network/invite

AUTHENTICATIONBearer token · workspaces:writeAUTHORITATIVE OWNERidentity-referralsCONTRACT 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

Planned capability: apply the requested transition to invite/refer a new user through the authoritative workspace service boundary.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future invite/refer a new user workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Create or advance

What changes

None today: this route is not executable. Its intended behavior is: none. It cannot select a workspace, invite or refer a user, revoke membership, or change a role.

WHY IT MATTERS

Lets people and agents prepare for invite/refer a new user without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance invite/refer a new user.
Keeps teams, resources, policies, credentials, wallets, and activity partitioned by workspace while allowing one identity to participate in multiple bounded environments.

ISOLATION + AUTHORITY

Tenant, identity, workspace, invitation, membership, role, active-workspace selection, resource ownership, wallet, policy, and entitlement boundaries remain distinct. Membership or selection does not grant tenant administration, wallet signing, payment, settlement, publisher, matching, or trading authority beyond separately evaluated scopes and policy. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Authenticate at the documented boundary: bearer.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
Resolve the tenant, authenticated identity, target workspace, current membership and role version, invitation state, and last-owner safeguards.

WHAT TO DO NEXT

Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
Use the stated owner, lifecycle, authority boundary, and provisional invite/refer a new user profile to prepare requirements and conformance tests without sending a request.
Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Use invite/refer a new user only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
Treat workspace creation, invitation, acceptance, active membership, role assignment, active-context selection, revocation, and dependent-resource access as separate state transitions.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

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 POST /api/v2/workspaces/{workspace_id}/invitations for bounded membership invitation; referrals are a separate Growth workflow."
}

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 POST /api/v2/workspaces/{workspace_id}/invitations for bounded membership invitation; referrals are a separate Growth workflow.
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/network/inviteNETWORK: Invite/Refer a new User

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 ↗