PureBasic / DocuSign REST API / Updates the notification structure for an existing template.
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"password","sample string 1")
CkJsonObject::ckUpdateString(json,"useAccountDefaults","sample string 2")
CkJsonObject::ckUpdateString(json,"reminders.reminderEnabled","sample string 1")
CkJsonObject::ckUpdateString(json,"reminders.reminderDelay","sample string 2")
CkJsonObject::ckUpdateString(json,"reminders.reminderFrequency","sample string 3")
CkJsonObject::ckUpdateString(json,"expirations.expireEnabled","sample string 1")
CkJsonObject::ckUpdateString(json,"expirations.expireAfter","sample string 2")
CkJsonObject::ckUpdateString(json,"expirations.expireWarn","sample string 3")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/notification",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndProcedure
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": [
]
}