Add envelope attachments

PUT

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

PUT

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

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/ENVELOPE_ID/attachments \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "attachments": [
    {
      "accessControl": "sample string 1",
      "attachmentId": "sample string 2",
      "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"
    }
  ]
}

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.

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.

envelopeIdstringRequired

The envelope’s GUID.

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

Request

This endpoint expects an object: envelopeAttachmentsRequest

attachmentslist of objectsOptional

An object that contains information about the attachment.

Response

Successful response.

attachmentslist of objectsOptional

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

Errors

400

Bad Request Error