Update document metadata

Update document metadata including title, description, category, access level, and validity information. File updates must be done separately.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title?string

Document title

Length1 <= length

slug?string

Optional URL-friendly slug for public links

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

description?string

Document description

description_markdown?string

Markdown-formatted description

access_level?string

Document access level

Value in

"public"
"restricted"
"requires_nda"
"internal"

issue_date?string

Issue date in YYYY-MM-DD format (empty string treated as null)

Match^\d{4}-\d{2}-\d{2}$

Formatdate

expiry_date?string

Expiry date in YYYY-MM-DD format (empty string treated as null)

Match^\d{4}-\d{2}-\d{2}$

Formatdate

validity_months?integer

Validity period in months

Range1 <= value

featured?

Featured placement flags for controls/resources sections

category?string

Category ID to assign document to

Formatuuid

variant_options?array<string>

Variant option IDs to assign this document to. Replaces all existing assignments. Only accepted on default-locale updates; supplying it on a non-default-locale (translation) update returns 400 with error variant_options_default_locale_only. Unknown or foreign option IDs return 400 with error unknown_variant_options. Option ownership is validated before any write; assignments are applied after the content update succeeds. If the content update succeeds but the assignment sync fails, the response is still 200 and includes variant_assignments_warning: variant_assignments_failed while omitting variant_options; an assignment-only update that fails to sync returns 500 with error variant_assignments_failed. On success the response echoes the assigned option IDs as variant_options.

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/documents/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{    "title": "Updated Privacy Policy",    "description": "Revised company privacy policy for 2025"  }'

{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "title": "string",    "slug": "string",    "description": "string",    "description_markdown": "string",    "category": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "icon": "string",      "translations": [        {          "locale": "string",          "title": "string",          "description": "string"        }      ]    },    "access_level": "public",    "status": "draft",    "issue_date": "2019-08-24",    "expiry_date": "2019-08-24",    "validity_months": 1,    "featured": {      "control": false,      "resource": false    },    "show_validity_period_on_card": true,    "file": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "filename_download": "string",      "filesize": 0,      "type": "string",      "title": "string",      "url": "http://example.com"    },    "date_created": "2019-08-24T14:15:22Z",    "date_updated": "2019-08-24T14:15:22Z",    "versioning": true,    "_version": {      "id": "string",      "key": "string",      "name": "string",      "status": "draft",      "is_active": true,      "date_created": "2019-08-24T14:15:22Z",      "date_updated": "2019-08-24T14:15:22Z"    },    "publishedVersions": [      {        "id": "string",        "name": "string",        "status": "draft",        "is_active": true,        "date_created": "2019-08-24T14:15:22Z",        "date_updated": "2019-08-24T14:15:22Z"      }    ],    "activeVersionId": "string",    "defaultVersionId": "string",    "defaultVersionName": "string"  }}

How is this guide?

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401

404

409application/json

500

`application/json`

`application/json`

`application/json`