Skip to main content
PATCH
Rename a canonical Library document

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Headers

Idempotency-Key
string
required

Request key; replay the same key only with the same payload.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$

Path Parameters

document
string<uuid>
required

Document.

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

title
string
required

Validation: required|string|min:1|max:255.

Required string length: 1 - 255
expected_record_version
integer
required

Validation: required|integer|min:1.

Required range: x >= 1

Response

Rename a canonical Library document response.

contract_version
string
outcome
string
command_receipt_id
string
document_id
string | null
idempotency_key_sha256
string
request_sha256
string
recorded_at
string<date-time>
result_sha256
string
document
failure
object | null

Domain rejection code and information, when outcome is conflict.