Chilkat Online Tools

Objective-C / DocuSign eSignature REST API / Add an attachment to a DRAFT or IN-PROCESS envelope.

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
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.

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"attachmentId" value: @"sample string 1"];
[json UpdateString: @"label" value: @"sample string 2"];
[json UpdateString: @"attachmentType" value: @"sample string 3"];
[json UpdateString: @"name" value: @"sample string 4"];
[json UpdateString: @"accessControl" value: @"sample string 5"];
[json UpdateString: @"data" value: @"sample string 6"];
[json UpdateString: @"remoteUrl" value: @"sample string 7"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments/{{attachmentId}}" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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}}",
          "type": "string"
        },
        {
          "key": "attachmentId",
          "value": "{{attachmentId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}