12. Lists the Existing Locks on an Envelope

GET {{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/lock

This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope.

The response to this request returns a lockToken parameter. You must use the lockToken to update or delete an existing lock. You must also include the lockToken in the header for every PUT call that you make on the envelope while it is locked. If you do not include the lockToken, the system returns the following error:

{ errorCode: EDIT_LOCK_NOT_LOCK_OWNER, message: The user is not the owner of the lock. The template is locked by another user or in another application } Note: Users must have envelope locking capability enabled to use this function (userSetting canLockEnvelopes must be set to true for the user).