Supported attachment formats include: .asp, .bmp, .csv, .doc, .docm, .docx, .dot, .dotm, .dotx, .gif, .htm, .html, .jpeg, .jpg, .msg, .pdf, .png, .pot, .potx, .pps, .ppt, .pptm, .pptx, .ps, .rtf, .tif, .tiff, .txt, .wpd, .xls, .xlsm, .xlsx, .xml, and .xps. For more information on supported file formats please see Supported File Formats.

Request

HTTP request

PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/attachments

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

envelopeAttachmentsResult
400

Error encountered.

errorDetails

SDK Method

Envelopes::putAttachments

Definitions

attachment

Contains information about an attachment.

accessControlstring

attachmentIdstring

attachmentTypestring

Specifies the type of the attachment for the recipient.

datastring

labelstring

namestring

remoteUrlstring

envelopeAttachmentsRequest

attachments[attachment]

envelopeAttachmentsResult

attachments[EnvelopeAttachments]

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

EnvelopeAttachments

accessControlstring

attachmentIdstring

attachmentTypestring

errorDetailserrorDetails

labelstring

namestring

Examples

Generic JSON Request/Response

Request
{
  "attachments": [
    {
      "attachmentId": "sample string 1",
      "label": "sample string 2",
      "attachmentType": "sample string 3",
      "name": "sample string 4",
      "accessControl": "sample string 5",
      "data": "sample string 6",
      "remoteUrl": "sample string 7"
    }
  ]
}
Response
{
  "attachments": [
    {
      "attachmentId": "sample string 1",
      "label": "sample string 2",
      "attachmentType": "sample string 3",
      "name": "sample string 4",
      "accessControl": "sample string 5",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Request/Response

Request
<envelopeAttachmentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <attachments>
    <attachment>
      <accessControl>sample string 5</accessControl>
      <attachmentId>sample string 1</attachmentId>
      <attachmentType>sample string 3</attachmentType>
      <data>sample string 6</data>
      <label>sample string 2</label>
      <name>sample string 4</name>
      <remoteUrl>sample string 7</remoteUrl>
    </attachment>
  </attachments>
</envelopeAttachmentsRequest> 
Response
<envelopeAttachmentsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <attachments>
    <envelopeAttachment>
      <accessControl>sample string 5</accessControl>
      <attachmentId>sample string 1</attachmentId>
      <attachmentType>sample string 3</attachmentType>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <label>sample string 2</label>
      <name>sample string 4</name>
    </envelopeAttachment>
  </attachments>
</envelopeAttachmentsResult> 
}} />