Deletes the lock from the specified envelope. The X-DocuSign-Edit header must be included in the request.

Request

HTTP request

DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/lock

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::deleteLock

Definitions Expand All | Collapse All

EnvelopeLocks

Envelope locks

errorDetails errorDetails
lockDurationInSeconds string

Sets the time, in seconds, until the lock expires when there is no activity on the envelope.

If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.

The lock duration can be extended.

lockedByApp string

Specifies the friendly name of the application that is locking the envelope.

lockedByUser userInfo

A complex type containing information about the user that has the Envelope or Template locked.

lockedUntilDateTime string

The datetime until the envelope lock expires.

lockToken string

A unique identifier provided to the owner of the envelope lock. Used to prove ownership of the lock.

lockType string

The type of envelope lock. Currently "edit" is the only supported type.

useScratchPad string

Reserved for future use.

Indicates whether a scratchpad is used for editing information.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

userInfo

activationAccessCode string
email string
errorDetails errorDetails
loginStatus string
sendActivationEmail string
uri string
userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

userName string
userStatus string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType string

Examples

Generic JSON Response

Response

{
"lockedByUser": {
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}
,
"lockedByApp": "sample string 1",
"lockedUntilDateTime": "sample string 2",
"lockDurationInSeconds": "sample string 3",
"lockType": "sample string 4",
"useScratchPad": "sample string 5",
"lockToken": "sample string 6",
"errorDetails": {
"errorCode": "SUCCESS",
"message": ""
}
}

Generic XML Response

Response

<lockInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<errorDetails>
<errorCode>SUCCESS</errorCode>
<message></message>
</errorDetails>
<lockDurationInSeconds>sample string 3</lockDurationInSeconds>
<lockToken>sample string 6</lockToken>
<lockType>sample string 4</lockType>
<lockedByApp>sample string 1</lockedByApp>
<lockedByUser>
<activationAccessCode>sample string 9</activationAccessCode>
<email>sample string 3</email>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<loginStatus>sample string 7</loginStatus>
<sendActivationEmail>sample string 8</sendActivationEmail>
<uri>sample string 6</uri>
<userId>sample string 2</userId>
<userName>sample string 1</userName>
<userStatus>sample string 5</userStatus>
<userType>sample string 4</userType>
</lockedByUser>
<lockedUntilDateTime>sample string 2</lockedUntilDateTime>
<useScratchPad>sample string 5</useScratchPad>
</lockInformation>