Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Document

Update Document

Update an existing 'Document' record.

patch/Document/{id}

Request body

idstring

An ID.

namestring

A one-line string.

fileIdstring

An ID of the record of the Attachment type.

fileNamestring nullable

A foreign record name.

status'Draft' | 'Active' | 'Canceled' | 'Expired'
type'Contract' | 'NDA' | 'EULA' | 'License Agreement' nullable
publishDatestring date

A date.

expirationDatestring date nullable

A date.

descriptionstring nullable

A multi-line text.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

accountsIdsstring[] nullable

IDs of records of the Account type.

accountsNamesobject nullable

An {ID => record name} map.

folderIdstring nullable

An ID of the record of the DocumentFolder type.

folderNamestring nullable

A foreign record name.

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

fileIdstring

An ID of the record of the Attachment type.

fileNamestring nullable

A foreign record name.

status'Draft' | 'Active' | 'Canceled' | 'Expired'
type'Contract' | 'NDA' | 'EULA' | 'License Agreement' nullable
publishDatestring date

A date.

expirationDatestring date nullable

A date.

descriptionstring nullable

A multi-line text.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

accountsIdsstring[] nullable

IDs of records of the Account type.

accountsNamesobject nullable

An {ID => record name} map.

folderIdstring nullable

An ID of the record of the DocumentFolder type.

folderNamestring nullable

A foreign record name.

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56"
}