Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Id: PWideChar;
DisplayName: PWideChar;
ConversationRetentionSeconds: Integer;
MaskCreditCardNumbers: Boolean;
UseAnimalNames: Boolean;
EchoPostback: Boolean;
IgnoreAutoConversationStart: Boolean;
MultiConvoEnabled: Boolean;
AttachmentsAccess: PWideChar;
AttachmentsTokenExpirationSeconds: Integer;
Lang: PWideChar;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'username');
CkHttp_putPassword(http,'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"
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'displayName','nisi');
CkJsonObject_UpdateInt(json,'settings.conversationRetentionSeconds',84530567);
CkJsonObject_UpdateBool(json,'settings.maskCreditCardNumbers',True);
CkJsonObject_UpdateBool(json,'settings.useAnimalNames',True);
CkJsonObject_UpdateBool(json,'settings.echoPostback',True);
CkJsonObject_UpdateBool(json,'settings.ignoreAutoConversationStart',True);
CkJsonObject_UpdateBool(json,'settings.multiConvoEnabled',True);
CkJsonObject_UpdateString(json,'settings.attachmentsAccess','public');
CkJsonObject_UpdateInt(json,'settings.attachmentsTokenExpirationSeconds',64028);
CkJsonObject_UpdateString(json,'metadata.lang','en-ca');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PATCH','https://domain.com/',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// 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 := CkJsonObject__stringOf(jResp,'app.id');
DisplayName := CkJsonObject__stringOf(jResp,'app.displayName');
ConversationRetentionSeconds := CkJsonObject_IntOf(jResp,'app.settings.conversationRetentionSeconds');
MaskCreditCardNumbers := CkJsonObject_BoolOf(jResp,'app.settings.maskCreditCardNumbers');
UseAnimalNames := CkJsonObject_BoolOf(jResp,'app.settings.useAnimalNames');
EchoPostback := CkJsonObject_BoolOf(jResp,'app.settings.echoPostback');
IgnoreAutoConversationStart := CkJsonObject_BoolOf(jResp,'app.settings.ignoreAutoConversationStart');
MultiConvoEnabled := CkJsonObject_BoolOf(jResp,'app.settings.multiConvoEnabled');
AttachmentsAccess := CkJsonObject__stringOf(jResp,'app.settings.attachmentsAccess');
AttachmentsTokenExpirationSeconds := CkJsonObject_IntOf(jResp,'app.settings.attachmentsTokenExpirationSeconds');
Lang := CkJsonObject__stringOf(jResp,'app.metadata.lang');
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
