Chilkat Online Tools

VBScript / Sunshine Conversations API / Update App

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

http.BasicAuth = 1
http.Login = "username"
http.Password = "password"

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

' The following JSON is sent in the request body.

' {
'   "displayName": "nisi",
'   "settings": {
'     "conversationRetentionSeconds": 84530567,
'     "maskCreditCardNumbers": true,
'     "useAnimalNames": true,
'     "echoPostback": true,
'     "ignoreAutoConversationStart": true,
'     "multiConvoEnabled": true,
'     "attachmentsAccess": "public",
'     "attachmentsTokenExpirationSeconds": 64028
'   },
'   "metadata": {
'     "lang": "en-ca"
'   }
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("displayName","nisi")
success = json.UpdateInt("settings.conversationRetentionSeconds",84530567)
success = json.UpdateBool("settings.maskCreditCardNumbers",1)
success = json.UpdateBool("settings.useAnimalNames",1)
success = json.UpdateBool("settings.echoPostback",1)
success = json.UpdateBool("settings.ignoreAutoConversationStart",1)
success = json.UpdateBool("settings.multiConvoEnabled",1)
success = json.UpdateString("settings.attachmentsAccess","public")
success = json.UpdateInt("settings.attachmentsTokenExpirationSeconds",64028)
success = json.UpdateString("metadata.lang","en-ca")

http.SetRequestHeader "Content-Type","application/json"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbRequestBody = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)

' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "app": {
'     "id": "5d8cff3cd55b040010928b5b",
'     "displayName": "utoc",
'     "settings": {
'       "conversationRetentionSeconds": 35855812,
'       "maskCreditCardNumbers": true,
'       "useAnimalNames": false,
'       "echoPostback": true,
'       "ignoreAutoConversationStart": true,
'       "multiConvoEnabled": true,
'       "attachmentsAccess": "public",
'       "attachmentsTokenExpirationSeconds": 64028
'     },
'     "metadata": {
'       "lang": "en-ca"
'     }
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Id = jResp.StringOf("app.id")
DisplayName = jResp.StringOf("app.displayName")
ConversationRetentionSeconds = jResp.IntOf("app.settings.conversationRetentionSeconds")
MaskCreditCardNumbers = jResp.BoolOf("app.settings.maskCreditCardNumbers")
UseAnimalNames = jResp.BoolOf("app.settings.useAnimalNames")
EchoPostback = jResp.BoolOf("app.settings.echoPostback")
IgnoreAutoConversationStart = jResp.BoolOf("app.settings.ignoreAutoConversationStart")
MultiConvoEnabled = jResp.BoolOf("app.settings.multiConvoEnabled")
AttachmentsAccess = jResp.StringOf("app.settings.attachmentsAccess")
AttachmentsTokenExpirationSeconds = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds")
Lang = jResp.StringOf("app.metadata.lang")

outFile.Close

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "displayName": "nisi",
    "settings": {
        "conversationRetentionSeconds": 84530567,
        "maskCreditCardNumbers": true,
        "useAnimalNames": true,
        "echoPostback": true,
        "ignoreAutoConversationStart": true,
        "multiConvoEnabled": true,
        "attachmentsAccess": "public",
        "attachmentsTokenExpirationSeconds": 64028
    },
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Update App",
  "_postman_id": "debaf927-71d4-4229-b132-c3115827c4a1",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"displayName\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}",
    "description": "Updates an app."
  },
  "response": [
    {
      "id": "3a281976-645d-4f5c-9ae9-3d6adf221d96",
      "name": "App not found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "3f6e52ca-11d5-41da-90e7-daff0b71c219",
      "name": "App metadata is limited to 4096 bytes in size.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "c86e51f9-c7d5-43d5-a82e-cd889fe21a5b",
      "name": "Ok",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"app\": {\n  \"id\": \"5d8cff3cd55b040010928b5b\",\n  \"displayName\": \"utoc\",\n  \"settings\": {\n   \"conversationRetentionSeconds\": 35855812,\n   \"maskCreditCardNumbers\": true,\n   \"useAnimalNames\": false,\n   \"echoPostback\": true,\n   \"ignoreAutoConversationStart\": true,\n   \"multiConvoEnabled\": true,\n   \"attachmentsAccess\": \"public\",\n   \"attachmentsTokenExpirationSeconds\": 64028\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    }
  ]
}