Update envelope attachment

PUT

/v2.1/accounts/:accountId/envelopes/:envelopeId/attachments/:attachmentId

PUT

/restapi/v2.1/accounts/:accountId/envelopes/:envelopeId/attachments/:attachmentId

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/attachments/ATTACHMENT_ID \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "accessControl": "sample string 1",
  "attachmentType": "sample string 3",
  "data": "sample string 4",
  "label": "sample string 5",
  "name": "sample string 6",
  "remoteUrl": "sample string 7"
}'

{
  "attachments": [
    {
      "accessControl": "sample string 1",
      "attachmentId": "sample string 2",
      "attachmentType": "sample string 3",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "label": "sample string 4",
      "name": "sample string 5"
    }
  ]
}

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.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

attachmentIdstringRequired

The unique identifier for the attachment.

envelopeIdstringRequired

The envelope’s GUID.

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

Request

This endpoint expects an object: attachment

accessControlstringOptional

Valid values are sender and senderAndAllRecipients.

attachmentIdstringOptional

The unique identifier for the attachment.

attachmentTypestringOptional

Specifies the type of the attachment for the recipient.

datastringOptional

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.

labelstringOptional

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.

namestringOptional

The name of the attachment.

remoteUrlstringOptional

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.

attachmentslist of objectsOptional

An array of attachment objects that contain information about the attachments.

Errors

400

Bad Request Error