Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("attachments[0].attachmentId", value: "sample string 1")
    json.UpdateString("attachments[0].label", value: "sample string 2")
    json.UpdateString("attachments[0].attachmentType", value: "sample string 3")
    json.UpdateString("attachments[0].name", value: "sample string 4")
    json.UpdateString("attachments[0].accessControl", value: "sample string 5")
    json.UpdateString("attachments[0].data", value: "sample string 6")
    json.UpdateString("attachments[0].remoteUrl", value: "sample string 7")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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