Put
If AttributeGroups collection is present, any new attribute groups will be added and unspecified attribute groups will be removed.
Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.
Authentication
AuthorizationBearer
Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.
Path parameters
id
ID of document.
accountId
The ID of the Docusign account.
Request
Document object definition.
Name
Name of the document. Filterable and sortable
CreatedDate
Created date of the document. Sortable
CreatedBy
Username of the user that created the document. Sortable
UpdatedDate
Last updated date for the document. Sortable
UpdatedBy
Username of the user that last updated the document. Sortable
Description
Description of the document. Filterable and sortable
Path
The file path of the document within the account's folder structure
AttributeGroups
Attribute groups saved on the document
PageCount
The page length of the document
LockStatus
Indicates the checked-out status of the latest version of the document. This field is populated for the latest version of the document. Load Lock Object for more details.
IsInTrash
Whether the document is in trash or not
Version
Version number of the document. Increments as the document is checked out and checked back in
PreviewUrl
Uri where a preview of the document can be viewed
Score
ElasticSearch relevancy score
Uid
Document Uid
NativeFileSize
File size in bytes
PdfFileSize
PDF rendition of file size in bytes
ContentCreatedDate
Date when the document was ingested/uploaded
Extension
Document extension
Href
Uri where the object can be retrieved.
ParentFolder
Folder containing the document
HistoryItems
A history of actions performed on the document
AccessLevel
Permissions on the document for the current user
EosParentInfo
Information about the external object storage folder that contains the document
Lock
The current lock status of the document
Versions
Other versions of the document
DocumentProcessTrackingActivities
Workflow user steps containing the document
DocumentReminders
Document reminders set for the document
RelatedDocuments
Related documents
AttachedDocuments
Attached documents
WorkItems
Work items for the document
Response
OK
Name
Name of the document. Filterable and sortable
CreatedDate
Created date of the document. Sortable
CreatedBy
Username of the user that created the document. Sortable
UpdatedDate
Last updated date for the document. Sortable
UpdatedBy
Username of the user that last updated the document. Sortable
Description
Description of the document. Filterable and sortable
Path
The file path of the document within the account's folder structure
AttributeGroups
Attribute groups saved on the document
PageCount
The page length of the document
LockStatus
Indicates the checked-out status of the latest version of the document. This field is populated for the latest version of the document. Load Lock Object for more details.
IsInTrash
Whether the document is in trash or not
Version
Version number of the document. Increments as the document is checked out and checked back in
PreviewUrl
Uri where a preview of the document can be viewed
DownloadDocumentHref
Uri where the document can be downloaded
Score
ElasticSearch relevancy score
Uid
Document Uid
NativeFileSize
File size in bytes
PdfFileSize
PDF rendition of file size in bytes
ContentCreatedDate
Date when the document was ingested/uploaded
Extension
Document extension
Href
Uri where the object can be retrieved.
ParentFolder
Folder containing the document
HistoryItems
A history of actions performed on the document
AccessLevel
Permissions on the document for the current user
EosParentInfo
Information about the external object storage folder that contains the document
Lock
The current lock status of the document
Versions
Other versions of the document
DocumentProcessTrackingActivities
Workflow user steps containing the document
DocumentReminders
Document reminders set for the document
RelatedDocuments
Related documents
AttachedDocuments
Attached documents
WorkItems
Work items for the document