Chilkat Online Tools

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

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

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

    CkHttpW http;
    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.

    // {
    //   "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"
    //   }
    // }

    CkJsonObjectW json;
    json.UpdateString(L"password",L"sample string 1");
    json.UpdateString(L"useAccountDefaults",L"sample string 2");
    json.UpdateString(L"reminders.reminderEnabled",L"sample string 1");
    json.UpdateString(L"reminders.reminderDelay",L"sample string 2");
    json.UpdateString(L"reminders.reminderFrequency",L"sample string 3");
    json.UpdateString(L"expirations.expireEnabled",L"sample string 1");
    json.UpdateString(L"expirations.expireAfter",L"sample string 2");
    json.UpdateString(L"expirations.expireWarn",L"sample string 3");

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

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/notification",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"%d\n",resp->get_StatusCode());
    wprintf(L"%s\n",resp->bodyStr());
    delete resp;
    }

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": [
  ]
}