DOCUMENTATIONv2

POST

Teams & workspaces

Resend invitation

/api/v2/workspaces/{workspace_id}/invitations/{invitation_id}/resend

AUTHENTICATIONBearer token · workspaces:writeAUTHORITATIVE OWNERidentity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Idempotently requeue an unexpired pending invitation for delivery without minting or revealing a token.

WHEN THIS CALL IS USEFUL

Call this when a tenant member, team administrator, account client, or workspace-aware agent needs to apply the documented resend invitation transition after re-reading the current authoritative state so it can create and select isolated workspaces and govern invitations, memberships, roles, and active execution context.

OUTCOME · Create or advance

What changes

Creates or advances only the resend invitation resource described by this contract after authorization, validation, policy, and idempotency gates pass.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance resend invitation.
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.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required workspace_id (path), invitation_id (path) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the tenant, authenticated identity, target workspace, current membership and role version, invitation state, and last-owner safeguards.

WHAT TO DO NEXT

Re-read the workspace roster and active-workspace selection to confirm the resulting invitation, membership, role, or context state.
After an ambiguous result, reconcile current state before retrying; preserve last-owner and concurrent-version safeguards.

AGENT GUIDANCE

Use resend invitation only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required workspace_id (path), invitation_id (path) exactly as defined by the live contract.
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.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing workspaces:write authority.EXAMPLEBearer hc_live_…

workspace_idpathRequired

identifierStable workspace id selecting the exact resource addressed by this route.EXAMPLEworkspace-id-01

invitation_idpathRequired

identifierCanonical invitation id. It selects the exact invitation id addressed by this route.EXAMPLEinvitation-id-01

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated stable key reused for retries of the same logical mutation.EXAMPLEpost-api-v2-workspaces-workspace-id-invitations-invitation-id-resend-request-001

X-Request-IDheaderOptional

string · nullableX-Request-ID request metadata evaluated before domain processing begins.

Content-DigestheaderRequired

stringRFC 9530 sha-256 digest of the exact transmitted request-body bytes.

Signature-InputheaderRequired

stringRFC 9421 sig1 input covering @method, @path, content-digest, content-type, and idempotency-key, with created, expires, nonce, keyid, and alg=ed25519.

SignatureheaderRequired

stringRFC 9421 sig1 Ed25519 signature made by an active key registered to the bearer client.

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published identity schema.

400invalid_security_requestThe identity, workspace, permission, or key request is invalid.

400missing_idempotency_keyA nonempty Idempotency-Key is required for this mutation.

401invalid_credentialsThe bearer or proof-of-possession credential is invalid.

403step_up_requiredThe caller lacks role authority or fresh purpose-bound approval.

404workspace_resource_not_foundThe requested workspace, membership, or invitation was not found.

409security_conflictThe requested permission or identity transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

200The operation completed and returned the current authoritative representation.Mutation completed · JSON RESPONSE+

{
  "delivery_status": "example-delivery-status",
  "idempotent_replay": true,
  "invitation_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "status": "ACTIVE",
  "workspace_id": "a7c13c85b4ad44f8a2b8c665f34c9910"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read the workspace roster and active-workspace selection to confirm the resulting invitation, membership, role, or context state.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.

401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer or proof-of-possession credential is invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

403The principal lacks the required scope, role, tenant, or step-up authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "The caller lacks role authority or fresh purpose-bound approval."
}

INTEGRATION DECISIONstep_up_required

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for tenant-bound workspaces, memberships, invitations, roles, preferences, revisions, and lifecycle receipts.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

404The requested resource does not exist within the authenticated authority boundary.Resource not visible · JSON RESPONSE+

{
  "code": "workspace_resource_not_found",
  "message": "The requested workspace, membership, or invitation was not found."
}

INTEGRATION DECISIONworkspace_resource_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

409The request conflicts with current state or an idempotency key was reused inconsistently.State reconciliation required · JSON RESPONSE+

{
  "code": "security_conflict",
  "message": "The requested permission or identity transition conflicts with current state."
}

INTEGRATION DECISIONsecurity_conflict

CALLER ACTION: Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY: Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

503The authoritative service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_security_unavailable",
  "message": "The authoritative Identity security service is temporarily unavailable."
}

INTEGRATION DECISIONidentity_security_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the workspace, active roster, invitation, membership and preference versions, role, tenant binding, and idempotent mutation receipt.
ESCALATE WHEN: Escalate when membership, invitation, role, optimistic version, tenant isolation, or last-administrator safety remains inconsistent.

OPERATIONAL NOTES

Security and lifecycle guarantees

Idempotently requeues an unexpired pending invitation for delivery without minting or disclosing a new token.
The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
Mutations are retry-safe only when the same Idempotency-Key and canonical request body are reused.
The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗