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
json.UpdateString("displayName","nisi")
json.UpdateInt("settings.conversationRetentionSeconds",84530567)
json.UpdateBool("settings.maskCreditCardNumbers",True)
json.UpdateBool("settings.useAnimalNames",True)
json.UpdateBool("settings.echoPostback",True)
json.UpdateBool("settings.ignoreAutoConversationStart",True)
json.UpdateBool("settings.multiConvoEnabled",True)
json.UpdateString("settings.attachmentsAccess","public")
json.UpdateInt("settings.attachmentsTokenExpirationSeconds",64028)
json.UpdateString("metadata.lang","en-ca")
http.SetRequestHeader("Content-Type","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
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 = jResp.StringOf("app.id")
Dim DisplayName As String = jResp.StringOf("app.displayName")
Dim ConversationRetentionSeconds As Integer = jResp.IntOf("app.settings.conversationRetentionSeconds")
Dim MaskCreditCardNumbers As Boolean = jResp.BoolOf("app.settings.maskCreditCardNumbers")
Dim UseAnimalNames As Boolean = jResp.BoolOf("app.settings.useAnimalNames")
Dim EchoPostback As Boolean = jResp.BoolOf("app.settings.echoPostback")
Dim IgnoreAutoConversationStart As Boolean = jResp.BoolOf("app.settings.ignoreAutoConversationStart")
Dim MultiConvoEnabled As Boolean = jResp.BoolOf("app.settings.multiConvoEnabled")
Dim AttachmentsAccess As String = jResp.StringOf("app.settings.attachmentsAccess")
Dim AttachmentsTokenExpirationSeconds As Integer = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds")
Dim Lang As String = 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}"
}
]
}
