Chilkat Online Tools

autoit / DocuSign eSignature REST API / Delete one or more attachments from a DRAFT envelope.

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

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

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("attachments[0].attachmentId","sample string 1")
$oJson.UpdateString("attachments[0].label","sample string 2")
$oJson.UpdateString("attachments[0].attachmentType","sample string 3")
$oJson.UpdateString("attachments[0].name","sample string 4")
$oJson.UpdateString("attachments[0].accessControl","sample string 5")
$oJson.UpdateString("attachments[0].data","sample string 6")
$oJson.UpdateString("attachments[0].remoteUrl","sample string 7")

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

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("DELETE","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -X DELETE
	-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": "Delete one or more attachments from a DRAFT envelope.",
  "request": {
    "method": "DELETE",
    "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": [
  ]
}