Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeAttachments

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

Updates an envelope attachment to a draft or in-process 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 in the concept guide.

</ds-inlinemessage> <!-- end notice DEVDOCS-114911 -->
put/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}

Path parameters

accountIdstring required

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

attachmentIdstring required

The unique identifier for the attachment.

envelopeIdstring required

The envelope's GUID.

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

Request body

accessControlstring

Valid values are sender and senderAndAllRecipients.

attachmentIdstring

The unique identifier for the attachment.

attachmentTypestring

Specifies the type of the attachment for the recipient.

datastring

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.

labelstring

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.
namestring

The name of the attachment.

remoteUrlstring

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

Successful response.