Chilkat Online Tools

Foxpro / DocuSign eSignature REST API / Sets envelope notification (Reminders/Expirations) structure for an existing envelope.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

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

loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("useAccountDefaults","sample string 1")
loJson.UpdateString("reminders.reminderEnabled","sample string 1")
loJson.UpdateString("reminders.reminderDelay","sample string 2")
loJson.UpdateString("reminders.reminderFrequency","sample string 3")
loJson.UpdateString("expirations.expireEnabled","sample string 1")
loJson.UpdateString("expirations.expireAfter","sample string 2")
loJson.UpdateString("expirations.expireWarn","sample string 3")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/notification",loSbRequestBody,"utf-8","application/json",loResp)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loResp
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Sets envelope notification (Reminders/Expirations) structure for an existing envelope.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"useAccountDefaults\": \"sample string 1\",\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}}/envelopes/{{envelopeId}}/notification",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "notification"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}