Chilkat Online Tools

C# / DocuSign eSignature REST API / 7. Add an Attachment to Envelope

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "attachments": [
//     {
//       "attachmentId": "123",
//       "data": "{{data}}",
//       "name": "sample_document",
//       "anchorIgnoreIfNotPresent": "false",
//       "anchorUnits": "inches"
//     }
//   ]
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("attachments[0].attachmentId","123");
json.UpdateString("attachments[0].data","{{data}}");
json.UpdateString("attachments[0].name","sample_document");
json.UpdateString("attachments[0].anchorIgnoreIfNotPresent","false");
json.UpdateString("attachments[0].anchorUnits","inches");

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse resp = http.PTextSb("PUT","https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "attachments": [{
        "attachmentId": "123",
        "data": {{document}},
        "name": "sample_document",
        "anchorIgnoreIfNotPresent": "false",
        "anchorUnits": "inches"
    }]
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments

Postman Collection Item JSON

{
  "name": "7. Add an Attachment to Envelope",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"attachments\": [{\n        \"attachmentId\": \"123\",\n        \"data\": {{document}},\n        \"name\": \"sample_document\",\n        \"anchorIgnoreIfNotPresent\": \"false\",\n        \"anchorUnits\": \"inches\"\n    }]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "attachments"
      ]
    },
    "description": "In this example, we will make further changes to our existing envelope by adding an attachmen to it."
  },
  "response": [
  ]
}