Chilkat Online Tools

Objective-C / DocuSign eSignature REST API / Sets envelope notification (Reminders/Expirations) structure for an existing envelope.

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.

// {
//   "useAccountDefaults": "sample string 1",
//   "reminders": {
//     "reminderEnabled": "sample string 1",
//     "reminderDelay": "sample string 2",
//     "reminderFrequency": "sample string 3"
//   },
//   "expirations": {
//     "expireEnabled": "sample string 1",
//     "expireAfter": "sample string 2",
//     "expireWarn": "sample string 3"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"useAccountDefaults" value: @"sample string 1"];
[json UpdateString: @"reminders.reminderEnabled" value: @"sample string 1"];
[json UpdateString: @"reminders.reminderDelay" value: @"sample string 2"];
[json UpdateString: @"reminders.reminderFrequency" value: @"sample string 3"];
[json UpdateString: @"expirations.expireEnabled" value: @"sample string 1"];
[json UpdateString: @"expirations.expireAfter" value: @"sample string 2"];
[json UpdateString: @"expirations.expireWarn" 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: @"PUT" url: @"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/notification" 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 PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "useAccountDefaults": "sample string 1",
  "reminders": {
    "reminderEnabled": "sample string 1",
    "reminderDelay": "sample string 2",
    "reminderFrequency": "sample string 3"
  },
  "expirations": {
    "expireEnabled": "sample string 1",
    "expireAfter": "sample string 2",
    "expireWarn": "sample string 3"
  }
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/notification

Postman Collection Item JSON

{
  "name": "Sets envelope notification (Reminders/Expirations) structure for an existing envelope.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"useAccountDefaults\": \"sample string 1\",\n  \"reminders\": {\n    \"reminderEnabled\": \"sample string 1\",\n    \"reminderDelay\": \"sample string 2\",\n    \"reminderFrequency\": \"sample string 3\"\n  },\n  \"expirations\": {\n    \"expireEnabled\": \"sample string 1\",\n    \"expireAfter\": \"sample string 2\",\n    \"expireWarn\": \"sample string 3\"\n  }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/notification",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "notification"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}