TCL / DocuSign eSignature REST API / Delete one or more attachments from a DRAFT envelope.
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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"
# }
# ]
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "attachments[0].attachmentId" "sample string 1"
CkJsonObject_UpdateString $json "attachments[0].label" "sample string 2"
CkJsonObject_UpdateString $json "attachments[0].attachmentType" "sample string 3"
CkJsonObject_UpdateString $json "attachments[0].name" "sample string 4"
CkJsonObject_UpdateString $json "attachments[0].accessControl" "sample string 5"
CkJsonObject_UpdateString $json "attachments[0].data" "sample string 6"
CkJsonObject_UpdateString $json "attachments[0].remoteUrl" "sample string 7"
# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "DELETE" "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/attachments" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
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": [
]
}