Chilkat Online Tools

phpExt / DocuSign eSignature REST API / Updates a template lock.

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$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.

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

$json = new CkJsonObject();
$json->UpdateString('lockedByApp','sample string 1');
$json->UpdateString('lockDurationInSeconds','sample string 2');
$json->UpdateString('lockType','sample string 3');
$json->UpdateString('useScratchPad','sample string 4');
$json->UpdateString('templatePassword','sample string 5');

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken('{{accessToken}}');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/lock',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X PUT
	-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": "Updates a template lock.",
  "request": {
    "method": "PUT",
    "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}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Updates the lock duration time or update the `lockedByApp` property information for the specified template. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated."
  },
  "response": [
  ]
}