View Source DocuSign.Api.EnvelopeLocks (DocuSign v1.2.0)
API calls for all endpoints tagged EnvelopeLocks
.
Summary
Functions
Deletes an envelope lock.
Deletes the lock from the specified envelope. The user deleting the lock must be the same user who locked the envelope. You must include the X-DocuSign-Edit
header as described in EnvelopeLocks: create. This method takes an optional query parameter that lets you specify whether changes made while the envelope was locked are kept or discarded. | Query Parameter | Description | | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | save_changes
| When true (the default), any changes made while the lock was active are saved. When false, any changes made while the envelope was locked are discarded. | ### Related topics - Common API Tasks: Locking and unlocking envelopes
Gets envelope lock information.
Retrieves general information about an envelope lock. The user requesting the information must be the same user who locked the envelope. You can use this method to recover the lock information, including the lockToken
, for a locked envelope. The X-DocuSign-Edit
header is included in the response. See EnvelopeLocks: create for a description of the X-DocuSign-Edit
header. ### Related topics - Common API Tasks: Locking and unlocking envelopes
Locks an envelope.
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 includes a lockToken
parameter that you must use in the X-DocuSign-Edit
header for every PUT method (typically a method that updates an envelope) while the envelope is locked. If you do not provide the lockToken
when accessing a locked envelope, you will get 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" }
### The X-DocuSign-Edit header The X-DocuSign-Edit
header looks like this and can be specified in either JSON or XML. JSON { "LockToken": "token-from-response", "LockDurationInSeconds": "600" }
XML <DocuSignEdit> <LockToken>token-from-response</LockToken> <LockDurationInSeconds>600</LockDurationInSeconds> </DocuSignEdit>
In the actual HTTP header, you would remove the linebreaks: X-DocuSign-Edit: {"LockToken": "token-from-response", "LockDurationInSeconds": "600" } or X-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>
### Related topics - Common API Tasks: Locking and unlocking envelopes
Updates an envelope lock.
Updates the lock information for a locked envelope. You must include the X-DocuSign-Edit
header as described in EnvelopeLocks: create. Use this method to change the duration of the lock (lockDurationInSeconds
) or the lockedByApp
string. The request body is a full lockRequest
object, but you only need to specify the properties that you are updating. For example: { "lockDurationInSeconds": "3600", "lockedByApp": "My Application" }
Functions
lock_delete_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Source@spec lock_delete_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Deletes an envelope lock.
Deletes the lock from the specified envelope. The user deleting the lock must be the same user who locked the envelope. You must include the X-DocuSign-Edit
header as described in EnvelopeLocks: create. This method takes an optional query parameter that lets you specify whether changes made while the envelope was locked are kept or discarded. | Query Parameter | Description | | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | save_changes
| When true (the default), any changes made while the lock was active are saved. When false, any changes made while the envelope was locked are discarded. | ### Related topics - Common API Tasks: Locking and unlocking envelopes
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.EnvelopeLocks.t}
on success{:error, Tesla.Env.t}
on failure
lock_get_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Source@spec lock_get_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Gets envelope lock information.
Retrieves general information about an envelope lock. The user requesting the information must be the same user who locked the envelope. You can use this method to recover the lock information, including the lockToken
, for a locked envelope. The X-DocuSign-Edit
header is included in the response. See EnvelopeLocks: create for a description of the X-DocuSign-Edit
header. ### Related topics - Common API Tasks: Locking and unlocking envelopes
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.EnvelopeLocks.t}
on success{:error, Tesla.Env.t}
on failure
lock_post_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Source@spec lock_post_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Locks an envelope.
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 includes a lockToken
parameter that you must use in the X-DocuSign-Edit
header for every PUT method (typically a method that updates an envelope) while the envelope is locked. If you do not provide the lockToken
when accessing a locked envelope, you will get 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" }
### The X-DocuSign-Edit header The X-DocuSign-Edit
header looks like this and can be specified in either JSON or XML. JSON { "LockToken": "token-from-response", "LockDurationInSeconds": "600" }
XML <DocuSignEdit> <LockToken>token-from-response</LockToken> <LockDurationInSeconds>600</LockDurationInSeconds> </DocuSignEdit>
In the actual HTTP header, you would remove the linebreaks: X-DocuSign-Edit: {"LockToken": "token-from-response", "LockDurationInSeconds": "600" } or X-DocuSign-Edit:<DocuSignEdit><LockToken>token-from-response</LockToken><LockDurationInSeconds>600</LockDurationInSeconds></DocuSignEdit>
### Related topics - Common API Tasks: Locking and unlocking envelopes
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts
(keyword): Optional parameters:body
(LockRequest):
Returns
{:ok, DocuSign.Model.EnvelopeLocks.t}
on success{:error, Tesla.Env.t}
on failure
lock_put_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View Source@spec lock_put_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Updates an envelope lock.
Updates the lock information for a locked envelope. You must include the X-DocuSign-Edit
header as described in EnvelopeLocks: create. Use this method to change the duration of the lock (lockDurationInSeconds
) or the lockedByApp
string. The request body is a full lockRequest
object, but you only need to specify the properties that you are updating. For example: { "lockDurationInSeconds": "3600", "lockedByApp": "My Application" }
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.envelope_id
(String.t): The envelope's GUID. Example:93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts
(keyword): Optional parameters:body
(LockRequest):
Returns
{:ok, DocuSign.Model.EnvelopeLocks.t}
on success{:error, Tesla.Env.t}
on failure