Skip to main content
PATCH
Update document

Authorizations

Authorization
string
header
required

API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...

Path Parameters

document_id
string
required

Document ID

Body

application/json
path
string | null

Virtual path for UI grouping

archived
boolean

Archive or unarchive document

Response

Document updated successfully

id
string
required

Unique document identifier

Example:

"doc_abc123"

case_id
string
required

Associated case ID

Example:

"case_xyz"

file_name
string
required

File name

Example:

"medical_record.pdf"

file_size
integer
required

File size in bytes

Example:

1234567

file_type
string
required

MIME type

Example:

"application/pdf"

archived
boolean
required

Whether document is archived

Example:

false

created_at
string<date-time>
required

Creation timestamp (ISO 8601)

Example:

"2025-02-01T12:34:56Z"

updated_at
string<date-time>
required

Last update timestamp (ISO 8601)

Example:

"2025-02-01T12:34:56Z"

path
string | null

Virtual path for UI grouping

Example:

"Example_General_Hospital"