DocuSign.Api.Envelopes.envelopes_put_envelope

You're seeing just the function envelopes_put_envelope, go back to DocuSign.Api.Envelopes module for more information.
Link to this function

envelopes_put_envelope(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

envelopes_put_envelope(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.EnvelopeUpdateSummary.t()} | {:error, Tesla.Env.t()}

Send, void, or modify a draft envelope. Purge documents from a completed envelope. This method lets you make changes to an envelope. You can use it to: Send a draft envelope Void an in-process envelope Modify a draft envelope Purge documents and envelope metadata from the DocuSign platform <div class="highlight highlight-info"> <p markdown="1"> Although the request body for this method is a complete envelope definition, you only need to provide properties that you're updating. </p> </div> ## Sending a Draft Envelope To send a draft envelope, include this in the request body: ```json { "status": "sent" } ``` ## Voiding an In-Process Envelope To void an in-process envelope, include this in the request body: ```json { "status": "voided", "voidedReason": "The reason for voiding the envelope" } ``` ## Modifying Envelope Email Information To change the email subject and message of a draft envelope, include this in the request body: ```json { "emailSubject": "new email subject", "emailBlurb": "new email message" } ``` ## Purging Documents from DocuSign To place only the documents in the purge queue, leaving any corresponding attachments and tabs in the DocuSign platform, set the `purgeState` property to `documents_queued`. ```json { "purgeState": "documents_queued" } ``` To place documents, attachments, and tabs in the purge queue, set the `purgeState` property to `documents_and_metadata_queued`. ```json { "purgeState": "documents_and_metadata_queued" } ``` You can purge documents only from completed envelopes that are not marked as the authoritative copy. The user requesting the purge must have permission to purge documents and must be the sender or be acting on behalf of the sender. When the purge request is initiated the items to be purged are placed in the purge queue for deletion in 14 days. The sender and all recipients with DocuSign accounts associated with the envelope get an email notification the the documents will be deleted in 14 days. The notification contains a link to the documents. A second email notification is sent 7 days later. At the end of the 14-day period the documents are deleted from the system. Recipients without DocuSign accounts do not receive email notifications. If your account has a Document Retention policy, envelope documents are automatically placed in the purge queue, and notification emails are sent at the end of the retention period. Setting a Document Retention policy is the same as setting a schedule for purging documents.

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
    • :advanced_update (String.t): When set to true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
    • :resend_envelope (String.t): When set to true, sends the specified envelope again.
    • :envelopes (Envelopes):

Returns

} on success {:error, info} on failure