Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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"
;   }
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("password","sample string 1")
$oJson.UpdateString("useAccountDefaults","sample string 2")
$oJson.UpdateString("reminders.reminderEnabled","sample string 1")
$oJson.UpdateString("reminders.reminderDelay","sample string 2")
$oJson.UpdateString("reminders.reminderFrequency","sample string 3")
$oJson.UpdateString("expirations.expireEnabled","sample string 1")
$oJson.UpdateString("expirations.expireAfter","sample string 2")
$oJson.UpdateString("expirations.expireWarn","sample string 3")

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/notification",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications."
  },
  "response": [
  ]
}