Skip to navigation
Docusign eSignature REST APIEnvelopes

EnvelopeAttachments Resource

View as Markdown

Envelope attachments are files that are associated an envelope. They are not visible to senders or to recipients and are not converted to PDF or any other format. These are files that your application uses to store information.

Envelope attachments are available only through the API.

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.

Methods supported

MethodDescription
createPUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Adds one or more envelope attachments to a draft or in-process envelope.
deleteDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Deletes one or more envelope attachments from a draft envelope.
getGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
Retrieves an envelope attachment from an envelope.
listGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments
Returns a list of envelope attachments associated with a specified envelope.
updatePUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}
Updates an envelope attachment in a draft or in-process envelope.

EnvelopeAttachments properties

PropertyTypeDescription
accessControlstringValid values are sender and senderAndAllRecipients.
attachmentIdstringThe unique identifier for the attachment.
attachmentTypestringSpecifies the type of the attachment for the recipient. Possible values are:
  • .htm
  • .xml
errorDetailserrorDetailsThis object describes errors that occur. It is only valid for responses and ignored in requests.
labelstringA 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.
namestringThe name of the attachment.