Chilkat Online Tools

C / DocuSign REST API / Updates the notification structure for an existing template.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkHttpResponse resp;

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

    http = CkHttp_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.

    // {
    //   "password": "sample string 1",
    //   "useAccountDefaults": "sample string 2",
    //   "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"
    //   }
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"password","sample string 1");
    CkJsonObject_UpdateString(json,"useAccountDefaults","sample string 2");
    CkJsonObject_UpdateString(json,"reminders.reminderEnabled","sample string 1");
    CkJsonObject_UpdateString(json,"reminders.reminderDelay","sample string 2");
    CkJsonObject_UpdateString(json,"reminders.reminderFrequency","sample string 3");
    CkJsonObject_UpdateString(json,"expirations.expireEnabled","sample string 1");
    CkJsonObject_UpdateString(json,"expirations.expireAfter","sample string 2");
    CkJsonObject_UpdateString(json,"expirations.expireWarn","sample string 3");

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

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);

    resp = CkHttp_PTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/notification",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);

    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "password": "sample string 1",
  "useAccountDefaults": "sample string 2",
  "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}}/templates/{{templateId}}/notification

Postman Collection Item JSON

{
  "name": "Updates the notification  structure for an existing template.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"password\": \"sample string 1\",\n  \"useAccountDefaults\": \"sample string 2\",\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}}/templates/{{templateId}}/notification",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "notification"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "description": "Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications."
  },
  "response": [
  ]
}