Chilkat Online Tools

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

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("password", value: "sample string 1")
    json.UpdateString("useAccountDefaults", value: "sample string 2")
    json.UpdateString("reminders.reminderEnabled", value: "sample string 1")
    json.UpdateString("reminders.reminderDelay", value: "sample string 2")
    json.UpdateString("reminders.reminderFrequency", value: "sample string 3")
    json.UpdateString("expirations.expireEnabled", value: "sample string 1")
    json.UpdateString("expirations.expireAfter", value: "sample string 2")
    json.UpdateString("expirations.expireWarn", value: "sample string 3")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PUT", url: "https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/notification", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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