Chilkat Online Tools

Objective-C / DocuSign REST API / Lock a template.

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.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.

// {
//   "lockedByApp": "sample string 1",
//   "lockDurationInSeconds": "sample string 2",
//   "lockType": "sample string 3",
//   "useScratchPad": "sample string 4",
//   "templatePassword": "sample string 5"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"lockedByApp" value: @"sample string 1"];
[json UpdateString: @"lockDurationInSeconds" value: @"sample string 2"];
[json UpdateString: @"lockType" value: @"sample string 3"];
[json UpdateString: @"useScratchPad" value: @"sample string 4"];
[json UpdateString: @"templatePassword" value: @"sample string 5"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "lockedByApp": "sample string 1",
  "lockDurationInSeconds": "sample string 2",
  "lockType": "sample string 3",
  "useScratchPad": "sample string 4",
  "templatePassword": "sample string 5"
}'
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock

Postman Collection Item JSON

{
  "name": "Lock a template.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"lockedByApp\": \"sample string 1\",\n  \"lockDurationInSeconds\": \"sample string 2\",\n  \"lockType\": \"sample string 3\",\n  \"useScratchPad\": \"sample string 4\",\n  \"templatePassword\": \"sample string 5\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "lock"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "description": "Locks the specified template, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the template.\n\n###### Note: Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user)."
  },
  "response": [
  ]
}