DocuSign.Api.EnvelopeLocks.lock_post_envelope_lock
You're seeing just the function
lock_post_envelope_lock
, go back to DocuSign.Api.EnvelopeLocks module for more information.
Link to this function
lock_post_envelope_lock(connection, account_id, envelope_id, opts \\ [])
View SourceSpecs
lock_post_envelope_lock(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.EnvelopeLocks.t()} | {:error, Tesla.Env.t()}
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
- opts (KeywordList): [optional] Optional parameters
- :lock_request (LockRequest):
Returns
} on success {:error, info} on failure