Chilkat Online Tools

Objective-C / DocuSign eSignature REST API / Deletes the signature for one or more captive recipient records.

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.

// {
//   "captiveRecipients": [
//     {
//       "email": "sample string 1",
//       "userName": "sample string 2",
//       "clientUserId": "sample string 3"
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"captiveRecipients[0].email" value: @"sample string 1"];
[json UpdateString: @"captiveRecipients[0].userName" value: @"sample string 2"];
[json UpdateString: @"captiveRecipients[0].clientUserId" value: @"sample string 3"];

// 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: @"DELETE" url: @"https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}" 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 DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "captiveRecipients": [
    {
      "email": "sample string 1",
      "userName": "sample string 2",
      "clientUserId": "sample string 3"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}

Postman Collection Item JSON

{
  "name": "Deletes the signature for one or more captive recipient records.",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"captiveRecipients\": [\n    {\n      \"email\": \"sample string 1\",\n      \"userName\": \"sample string 2\",\n      \"clientUserId\": \"sample string 3\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/captive_recipients/{{recipientPart}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "captive_recipients",
        "{{recipientPart}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "recipientPart",
          "value": "{{recipientPart}}",
          "type": "string"
        }
      ]
    },
    "description": "Deletes the signature for one or more captive recipient records; it is primarily used for testing. This provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used."
  },
  "response": [
  ]
}