Chilkat Online Tools

unicodeC / DocuSign REST API / Updates an envelope lock.

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

    // 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 = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"lockedByApp",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"lockDurationInSeconds",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"lockType",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"useScratchPad",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"templatePassword",L"sample string 5");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttpW_putAuthToken(http,L"{{accessToken}}");
    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/lock",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);

    }

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}}/envelopes/{{envelopeId}}/lock

Postman Collection Item JSON

{
  "name": "Updates an envelope 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}}/envelopes/{{envelopeId}}/lock",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "lock"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. 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": [
  ]
}