Chilkat Online Tools

Node.js / DocuSign REST API / Add an attachment to a DRAFT or IN-PROCESS envelope.

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var 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.

    // {
    //   "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"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("attachmentId","sample string 1");
    json.UpdateString("label","sample string 2");
    json.UpdateString("attachmentType","sample string 3");
    json.UpdateString("name","sample string 4");
    json.UpdateString("accessControl","sample string 5");
    json.UpdateString("data","sample string 6");
    json.UpdateString("remoteUrl","sample string 7");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    http.AuthToken = "{{accessToken}}";
    http.SetRequestHeader("Accept","application/json");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments/{{attachmentId}}",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "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"
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments/{{attachmentId}}

Postman Collection Item JSON

{
  "name": "Add an attachment to a DRAFT or IN-PROCESS envelope.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"attachmentId\": \"sample string 1\",\n  \"label\": \"sample string 2\",\n  \"attachmentType\": \"sample string 3\",\n  \"name\": \"sample string 4\",\n  \"accessControl\": \"sample string 5\",\n  \"data\": \"sample string 6\",\n  \"remoteUrl\": \"sample string 7\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments/{{attachmentId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "attachments",
        "{{attachmentId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "attachmentId",
          "value": "{{attachmentId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}