Chilkat Online Tools

delphiAx / DocuSign eSignature REST API / Add one or more attachments to a DRAFT or IN-PROCESS envelope.

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

// 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": "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"
//     }
//   ]
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('attachments[0].attachmentId','sample string 1');
json.UpdateString('attachments[0].label','sample string 2');
json.UpdateString('attachments[0].attachmentType','sample string 3');
json.UpdateString('attachments[0].name','sample string 4');
json.UpdateString('attachments[0].accessControl','sample string 5');
json.UpdateString('attachments[0].data','sample string 6');
json.UpdateString('attachments[0].remoteUrl','sample string 7');

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

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PUT','https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

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

Postman Collection Item JSON

{
  "name": "Add one or more attachments 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  \"attachments\": [\n    {\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    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "attachments"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}