Chilkat Online Tools

Xojo / Sunshine Conversations API / Update App

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
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"
//   }
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("displayName","nisi")
success = json.UpdateInt("settings.conversationRetentionSeconds",84530567)
success = json.UpdateBool("settings.maskCreditCardNumbers",True)
success = json.UpdateBool("settings.useAnimalNames",True)
success = json.UpdateBool("settings.echoPostback",True)
success = json.UpdateBool("settings.ignoreAutoConversationStart",True)
success = json.UpdateBool("settings.multiConvoEnabled",True)
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"

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
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

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

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