DocuSign

This method updates an account brand.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

This method updates a single brand logo.

You pass in the new version of the resource in the Content-Disposition header. Example:

Content-Disposition: form-data; name="file"; filename="logo.jpg"

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

This method updates a branding resource file.

You pass in the new version of the resource file in the Content-Disposition header. Example:

Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Important: Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.

When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.

Account administrators can use this method to perform the following tasks:

• Customize values in the default disclosure.
• Switch to a custom disclosure that uses your own text and HTML formatting.
• Change values in your existing consumer disclosure.

To specify the signer language version of the disclosure that you are updating, use the optional langCode query parameter.

Note: Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version.

Updating the default disclosure

When you update the default disclosure, you can edit all properties except for the following ones:

• accountEsignId: This property is read-only.
• custom: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure.
• esignAgreement: This property is read-only.
• esignText: You cannot edit this property when custom is set to false. The API returns a 200 OK HTTP response, but does not update the esignText.
• Metadata properties: These properties are read-only.

Note: The text of the default disclosure is always in English.

Switching to a custom disclosure

To switch to a custom disclosure, set the custom property to true and customize the value for the eSignText property.

You can also edit all of the other properties except for the following ones:

• accountEsignId: This property is read-only.
• esignAgreement: This property is read-only.
• Metadata properties: These properties are read-only.

Note: When you use a custom disclosure, you can create versions of it in different signer languages and se the langCode parameter to specify the signer language version that you are updating.

Important: When you switch from a default to a custom disclosure, note the following information:

• You will not be able to return to using the default disclosure.
• Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.

Updating a custom disclosure

When you update a custom disclosure, you can update all of the properties except for the following ones:

• accountEsignId: This property is read-only.
• esignAgreement: This property is read-only.
• Metadata properties: These properties are read-only.

Important: Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.

This method updates an existing account custom field.

This method updates the password rules for an account.

Note: To update the password rules for an account, you must be an account administrator.

This method updates an account permission profile.

Related topics

• How to update individual permission settings

Adds or updates one or more account stamps. This request may include images in multi-part format.

Updates an account stamp specified by the signatureId query parameter.

Sets a signature image, initials, or stamp.

This method modifies the tab types and tab functionality that is enabled for an account.

Returns information about the watermark for the account.

Update the watermark for the account.

Note: Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.

Updates the account settings for the specified account.

Although the request body for this method
is a complete
accountSettingsInformation object,
you only need to provide
the properties that
you are updating.

An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method sets the envelope purge configuration for your account.

Note: To use this method, you must be an account administrator.

For more information, see Purge Envelopes.

This method changes the default settings for the email notifications that signers and senders receive about envelopes.

This sets the shared access status for one or more users or templates.

When setting user shared access, only users with account administration privileges can set shared access status for envelopes.

When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates.

Changes to the shared items status are not additive. The change always replaces the current status.

To change template shared access, add the query parameter item_type = templates to the request. When this is set, the user and envelopes properties are not required.

Note: This functionality is a newer version of the Update Group Share functionality.

Updates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters.

To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.

Updates the billing plan information, billing address, and credit card information for the specified account.

Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.

Updates the name of a bulk send batch.

Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.

This method replaces the definition of an existing bulk send list.

This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls.

If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.

Note: After you commit a chunked upload, it no longer accepts additional parts.

Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part,
use this method to upload subsequent parts.

For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the sequence value 0. As a result, DocuSign recommends that you start with a sequence value of 1 when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.

Example:

PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2
PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3

Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.

Updates the specified DocuSign Connect configuration in your account. To enable the configuration, set the allowEnvelopePublish property to true.

After any updates, test your configuration to make sure it works as expected.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to Connect::listEventLogs retrieve the failure log.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

Republishes Connect information for the specified envelope.

Note: To use this function, you must be an account administrator and Connect must be enabled on your account.

This method updates one or more contacts associated with an account.

Updates the information in a custom tab for the specified account.

This method updates the form fields
for all the documents in a given
envelope.

The envelope must be in the draft state.

The request body for an envelope that has one document
with form fields would look like this:

{
  "docGenFormFields": [
    {
      "documentId": "2dc54cf5-xxxx-xxxx-xxxx-05132a2dd889",
      "docGenFormFieldList": [
        {
          "name": "Candidate_Name",
          "value": "Peggy Olson"
        },
        {
          "name": "Job_Title",
          "value": "Copywriter"
        },
        {
          "name": "Manager_Name",
          "value": "Donald Draper"
        },
        {
          "name": "Start_Date",
          "value": "March 15, 1960"
        },
        {
          "name": "Salary",
          "value": "8000"
        }
      ]
    }
  ]
}

Related topics

• Document generation in the eSignature concepts guide
• How to request a signature by email with document generation
• Document Generation for DocuSign eSignature in the eSignature User Guide

Adds one or more envelope attachments to a draft or in-process envelope.
Each envelope can have a maximum of 12 attachments.

Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them.

For a list of supported file formats, see Supported File Formats.

Updates an envelope attachment to a draft or in-process envelope.

Updates the envelope custom fields in draft and in-process envelopes.

Each custom field used in an envelope must have a unique name.

Updates existing custom document fields in an existing envelope document.

Updates tabs in the document specified by documentId in the
envelope specified by envelopeId.

This method updates document visibility for one or more recipients based on the recipientId and visible values that you include in the request body.

Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

This method updates document visibility for a recipient.

Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.

Adds one or more documents to an existing envelope.
The tabs of the original document will be applied to the new document.

Note: When adding or modifying documents for an in-process envelope,
DocuSign recommends
locking the envelope
prior to making any changes.

If the file name of a document contains Unicode characters, you need to include a Content-Disposition header. Example:

Header: Content-Disposition

Value: file; filename=\"name\";fileExtension=ext;documentId=1

Adds or replaces a document in an existing draft or in-process envelope.
An in-process envelope is one that has been sent but not yet completed or voided.

Note: When adding or modifying documents for an in-process envelope,
DocuSign recommends
locking the envelope
prior to making any changes.

To add a new document, set the documentId path parameter to a new document ID.

To replace a document, set the documentId path parameter to the document ID of the existing document.
The tabs of the original document will be applied to the new document.
For example, a request in cURL looks like this:

$ curl --location --request PUT 'https://demo.docusign.net/restapi/v2.1/accounts/0cdb3ff3-xxxx-xxxx-xxxx-e43af011006d/envelopes/ea4cc25b-xxxx-xxxx-xxxx-a67a0a2a4f6c/documents/1' \
    --header 'Authorization: Bearer eyJ...bqg' \
    --header 'Content-Disposition: filename="newDocument"' \
    --header 'Content-Type: application/pdf' \
    --data-binary '@/location/of/document.pdf'

Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.

This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.

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"
}

Updates one or more tabs for a recipient in a draft envelope.
A draft envelope is one that is not yet complete.

Note: It is an error to update a tab that has the
templateLocked property set to true.
This property corresponds to the Restrict changes option in the web app.

Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope.

If you send information for a recipient that does not already
exist in a draft envelope, the recipient is added to the envelope
(similar to the EnvelopeRecipients: Create method).

You can also use this method to resend an envelope to a recipient
by using the resend_envelope option.

Updating Sent Envelopes

After an envelope has been sent, you can edit only the following properties:

• accessCode
• agentCanEditName
• agentCanEditEmail
• customFields
• deliveryMethod
• documentVisibility
• email (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.)
• emailNotification
• idCheckConfigurationName
• identityVerification
• name
• note
• phoneAuthentication
• recipientType (For this to work, you must also change the recipient object to match the recipient type.)
• requireIdLookup
• routingOrder
• routingOrder
• signingGroupId (You can change this ID to switch to a different signing group and its corresponding set of recipients.)
• smsAuthentication
• suppressEmails
• userName

If the recipient has signed,
but the envelope is still active,
the method will return success,
but the recipientUpdateResults property
in the response will include an error
that the recipient could not be updated:

{
  "recipientUpdateResults": [
    {
      "recipientId": "999",
      "errorDetails": {
        "errorCode": "RECIPIENT_UPDATE_FAILED",
        "message": "The recipient could not be updated.  Recipient not in state that allows correction."
      }
    }
  ]
}

If the envelope is completed,
and you try to change a recipient’s address,
the method will fail with this error:

{
  "errorCode": "ENVELOPE_INVALID_STATUS",
  "message": "Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct."
}

Note: This method works on recipients only.
To add recipient tabs,
use methods from the EnvelopeRecipientTabs resource.
For example, this request body will add a recipient (astanton@example.com)
but NOT the Sign Here recipient tab.

{
  "signers": [
    {
      "email": "astanton@example.com",
      "name": "Anne Stanton",
      "recipientId": "1",
// THIS WILL NOT WORK
      "tabs": {
        "signHereTabs": [
          {
            "anchorString": "below",
            "tooltip": "please sign here3"
          },
          . . .
        ]
      }
    }
  ]
}

This method changes the status for one or more envelope transfer rules based on the envelopeTransferRuleIds in the request body. You use this method to change whether or not the rules are enabled.

Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.