Skip to main content
PATCH
/
v1
/
knowledge-base
/
documents
/
{doc_id}
/
versions
/
{version_id}
/
governance
Update a version's lifecycle governance status / expiry
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/documents/{doc_id}/versions/{version_id}/governance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "expires_at": "2023-11-07T05:31:56Z",
  "reason_code": "<string>",
  "note": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_number": 123,
  "state": "<string>",
  "scan_status": "<string>",
  "governance_status": "<string>",
  "effective_serving_status": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "governance_reason_code": "<string>",
  "governance_note": "<string>",
  "governance_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "governance_updated_at": "2023-11-07T05:31:56Z",
  "governance_policy_version": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
doc_id
string<uuid>
required
​
version_id
string<uuid>
required

Body

application/json

PATCH body. extra='forbid' rejects unknown keys; field presence is read via model_fields_set so an explicit expires_at: null (clear) is distinguishable from an omitted expires_at (leave unchanged).

​
governance_status
enum<string> | null
Available options:
active,
retired,
suppressed,
manual_hold,
expired
​
expires_at
string<date-time> | null
​
reason_code
string | null
Maximum string length: 64
​
note
string | null
Maximum string length: 2000
​
idempotency_key
string | null
Maximum string length: 128

Response

Successful Response

Governance view of a version + the computed effective serving status.

​
id
string<uuid>
required
​
document_id
string<uuid>
required
​
knowledge_base_id
string<uuid>
required
​
version_number
integer
required
​
state
string
required
​
scan_status
string
required
​
governance_status
string
required
​
effective_serving_status
string
required
​
expires_at
string<date-time> | null
​
governance_reason_code
string | null
​
governance_note
string | null
​
governance_updated_by
string<uuid> | null
​
governance_updated_at
string<date-time> | null
​
governance_policy_version
string | null