Update document metadata
Update document metadata including title, description, category, access level, and validity information. File updates must be done separately.
AuthorizationBearer <token>
In: header
Path Parameters
idstring
Document ID
Format
uuidtitle?string
Document title
Length
1 <= lengthdescription?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}$Format
dateexpiry_date?string
Expiry date in YYYY-MM-DD format (empty string treated as null)
Match
^\d{4}-\d{2}-\d{2}$Format
datevalidity_months?integer
Validity period in months
Range
1 <= valuefeatured?boolean
Whether document should be featured
category?string
Category ID to assign document to
Format
uuidResponse Body
const body = JSON.stringify({})
fetch("https://app.orbiqhq.com/api/v1/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
body
}){
"success": true,
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"description_markdown": "string",
"category": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string"
},
"access_level": "public",
"issue_date": "2025-01-01",
"expiry_date": "2026-01-01",
"validity_months": 1,
"state": "valid",
"featured": 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"
}
}{
"error": {
"type": "validation_error",
"code": "invalid_date_format",
"message": "Invalid date format provided"
}
}Empty
Empty
Empty
How is this guide?