POSTpartial

Create or rotate a respondent invitation

Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.

/api/cases/{id}/invitationscreateInvitationPreview

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalPartnerBearer

CanonicalSession

AccountOAuth

Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}
Idempotency-KeyheaderOptional{"type":"string"}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/CanonicalInvitationInput",
  "type": "object",
  "additionalProperties": false,
  "description": "Respondent invitation rotation. The operation accepts an empty object or the single rotate action; any other field is refused. No required field exists because rotation is the only supported act.",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "rotate"
      ]
    }
  }
}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalInvitationEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalInvitationResult",
      "type": "object",
      "required": [
        "caseId",
        "hostedLink",
        "capabilityDelivery"
      ],
      "description": "Invitation rotation result. A show-once capability is never returned again on replay; hostedLink then addresses the hosted join page.",
      "properties": {
        "caseId": {
          "type": "string"
        },
        "hostedLink": {
          "type": "string"
        },
        "capabilityDelivery": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
201

Answer or invitation created through the shared partner operation.

application/json

{
  "$ref": "#/components/schemas/CanonicalInvitationEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalInvitationResult",
      "type": "object",
      "required": [
        "caseId",
        "hostedLink",
        "capabilityDelivery"
      ],
      "description": "Invitation rotation result. A show-once capability is never returned again on replay; hostedLink then addresses the hosted join page.",
      "properties": {
        "caseId": {
          "type": "string"
        },
        "hostedLink": {
          "type": "string"
        },
        "capabilityDelivery": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
404

Preview disabled or resource unavailable.

default

Stable problem code and requestId; no protected state disclosed.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "caseId": "pcase_test_123",
    "hostedLink": "hostedLink_test",
    "capabilityDelivery": "capabilityDelivery_test"
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.