Skip to main content
PATCH
Update document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Unique document key, typically a file path.

Example:

"contracts/acme-nda-2024.docx"

Body

application/json
key
string
required

Document key — used to derive the storage subject.

Example:

"contracts/acme-nda-2024.docx"

created_at
string<date-time>
name
string
Example:

"Acme NDA 2024"

output
object | null
template
object
signatures
object[] | null
errors
string[] | null

Response

Document updated successfully.

subject
string

Messaging subject of the created or updated record. Formats: draft template ms.document.draft.template.{key}, published template ms.document.template.{key}, document ms.document.document.{key} — with keys sanitised into subject tokens (/ → ., spaces → _, other special characters → uXXXX codes).

Example:

"ms.document.draft.template.invoice-template"