Skip to main content
POST
Set a knowledge case's steward
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/knowledge/cases/setSteward with { entryId, ownerWorkerId?, verifyEveryDays? } sets a case’s steward and its opt-in verification interval. Give at least one: an omitted field is kept and null clears it. ownerWorkerId must be an active employee or contractor worker; verifyEveryDays is a whole number from 1 to 3650. It needs knowledge:manage and answers { entryId, ownerWorkerId, verifyEveryDays, verificationDueAt }. An unchanged value writes and audits nothing; a change is audited with the credential’s attribution: a Personal key as its owner, with the key named on the audit event (via: "personal_key", apiKeyId); an External App as external-app:<id>, with the people who granted its access; a platform key as platform-key:<id>. Only a person-curated case has a steward: a pending revision, a retired case, a case synced from a knowledge source and an entry that is not a case answer 404 resource_missing, as does a case outside reach. Send an Idempotency-Key to retry safely; see Knowledge curation replay.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

1–255 printable ASCII characters. A repeat with the same key and request never runs the write again, a 5xx included. It returns the first response (Idempotency-Replayed: true) only when the route's current authorization policy permits disclosure; otherwise 409 idempotency_result_unavailable. Honoured for External App JWTs and platform and MCP keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Path Parameters

caseId
string
required
Minimum string length: 1

Body

application/json

A case's steward (an active employee or contractor worker id) and verification interval (whole days, 1–3650). Give at least one; an omitted field is kept and null clears it.

ownerWorkerId
string | null
Minimum string length: 1
verifyEveryDays
integer | null
Required range: 1 <= x <= 3650

Response

The case's stewardship

data
object
required

A case's steward and verification interval after the change, each null when unset, and when verification next falls due.

meta
object
required