Add Attachments (POST /v2.0/envelopes/{envelopeId}/upload_supporting_document)
Add up to ten attachments to the document being signed.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Query String Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelople ID for the added supporting document |
Request Body Parameters (Form Data)
| Field | Type | Required | Description |
|---|---|---|---|
| file | form-data | Yes | Envelope attachment file |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | Files attached successfully. |
| envelope_id | Envelope ID |
| supporting_document_id | Generated attachment ID |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/upload_supporting_document' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--form 'file=@"/C:/attachments.pdf"'
RESPONSE:
{
"message": "Supporting documents added successfully.",
"data": {
"envelope_id": "d19de705-5d48-4ae8-b781-000148198961",
"supporting_document_id": "334e974d-6731-41fe-9fbd-2d1baab5bd5e"
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/upload_supporting_document' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--form 'file=@"/C:/attachment.pdf"'
RESPONSE:
{
"errors": [
{
"error_code": "FILE_SIZE_LIMIT_EXCEEDED",
"developer_message": "File size limit should not exceed 25 MB"
}
]
}
Note: View the full list of applicable error code for this method here.