Skip to navigation
API referenceObjectsDocuments

Put lock

View as Markdown

Checks in a document. Use comment field of DocumentLock object to add a note to the action.

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

idstringRequiredformat: "uuid"
ID of document.
accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Request

Partially defined DocumentLock object.
IsLockedbooleanOptional
If the document is locked
LockDatedatetimeOptional
When the document was locked. Null if the document is not locked
TypestringOptional

Type of document lock. Possibilities: not checked out, checked out, out for signature

CommentstringOptional
Comment provided by the user when the document was locked
CheckInHrefstringOptional
If the document is checked out, this is the URI where it can be checked in
SignatureHrefstringOptional

If the lock due to a pending signature(s), this is the URI for checking signature status

HrefstringOptional
Uri where the object can be retrieved.
LockOwnerobjectOptional
The owner of the lock. Null if not locked

Response

OK
IsLockedbooleanOptional
If the document is locked
LockDatedatetimeOptional
When the document was locked. Null if the document is not locked
TypestringOptional

Type of document lock. Possibilities: not checked out, checked out, out for signature

CommentstringOptional
Comment provided by the user when the document was locked
CheckInHrefstringOptional
If the document is checked out, this is the URI where it can be checked in
SignatureHrefstringOptional

If the lock due to a pending signature(s), this is the URI for checking signature status

HrefstringOptional
Uri where the object can be retrieved.
LockOwnerobjectOptional
The owner of the lock. Null if not locked