Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Envelope Attachments

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

PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

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

It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments.

To learn about the different types of attachments, see Attachments in the concept guide.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

attachmentId*string

The unique identifier for the attachment.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request Body

application/json

Contains information about an attachment.

accessControl?string

Valid values are sender and senderAndAllRecipients.

attachmentId?string

The unique identifier for the attachment.

attachmentType?string

Specifies the type of the attachment for the recipient.

data?string

A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.

label?string

A label for the attachment. Potential values include:

  • guidedForm: Guided forms provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.
  • eventNotifications: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the url property.
name?string

The name of the attachment.

remoteUrl?string

The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the remoteUrl property to reference the chunked upload as the content in attachment and document-related requests. The remoteUrl property cannot be used for downloads.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/string/attachments/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "attachments": [    {      "accessControl": "string",      "attachmentId": "string",      "attachmentType": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "label": "string",      "name": "string"    }  ]}

Retrieves an envelope attachment from an envelope GET

Retrieves an envelope attachment from an envelope. <!-- std notice DEVDOCS-114911 --> <ds-inlinemessage kind="information" markdown="1"> It's easy to confuse envelope attachments, which are developer-only files associated with an envelope, with signer attachments. To learn about the different types of attachments, see [Attachments](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/documents/attachments/) in the concept guide. </ds-inlinemessage> <!-- end notice DEVDOCS-114911 -->

Gets a list of permission profiles GET

This method returns a list of permission profiles that are associated with an account. Example: ```json { "permissionProfiles": [ { "permissionProfileId": "1665536", "permissionProfileName": "Account Administrator", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665537", "permissionProfileName": "DocuSign Sender", "modifiedDateTime": "2018-03-26T03:54:40.4470000Z", "modifiedByUsername": "" }, { "permissionProfileId": "1665538", "permissionProfileName": "DocuSign Viewer", "modifiedDateTime": "2016-06-02T01:53:15.6830000Z", "modifiedByUsername": "" }, { "permissionProfileId": "10325926", "permissionProfileName": "DS Manage Company Member Accounts", "modifiedDateTime": "2020-05-15T00:28:36.8230000Z", "modifiedByUsername": "Nat Irving" } ] } ```