Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Id;
const char *v_Type;
const char *Status;
const char *DisplayName;
const char *ServerId;
BOOL CanUserCreateMoreConversations;
// 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": "My awesome integration",
// "serverKey": "<server-key>",
// "senderId": "<sender-id>",
// "canUserCreateConversation": false
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"displayName","My awesome integration");
CkJsonObject_UpdateString(json,"serverKey","<server-key>");
CkJsonObject_UpdateString(json,"senderId","<sender-id>");
CkJsonObject_UpdateBool(json,"canUserCreateConversation",FALSE);
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PATCH","https://domain.com/v2/apps/{{appId}}/integrations/:integrationId",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "integration": {
// "id": "5e4af71a81966cfff3ef6550",
// "type": "android",
// "status": "active",
// "displayName": "Android",
// "serverId": "<sender-id>",
// "canUserCreateMoreConversations": true
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObject_stringOf(jResp,"integration.id");
v_Type = CkJsonObject_stringOf(jResp,"integration.type");
Status = CkJsonObject_stringOf(jResp,"integration.status");
DisplayName = CkJsonObject_stringOf(jResp,"integration.displayName");
ServerId = CkJsonObject_stringOf(jResp,"integration.serverId");
CanUserCreateMoreConversations = CkJsonObject_BoolOf(jResp,"integration.canUserCreateMoreConversations");
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": "My awesome integration",
"serverKey": "<server-key>",
"senderId": "<sender-id>",
"canUserCreateConversation": false
}'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId
Postman Collection Item JSON
{
"name": "Update Integration",
"_postman_id": "08d2d65c-5d81-4bc8-b5a9-feb8c27b4529",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"displayName\": \"My awesome integration\",\n \"serverKey\": \"<server-key>\",\n \"senderId\": \"<sender-id>\",\n \"canUserCreateConversation\": false\n}"
},
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"integrations",
":integrationId"
],
"variable": [
{
"key": "integrationId"
}
]
},
"description": "Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data."
},
"response": [
{
"id": "70fa76fe-4bb4-4a55-a725-441c3c6184e2",
"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\": \"My awesome integration\",\n \"serverKey\": \"<server-key>\",\n \"senderId\": \"<sender-id>\",\n \"canUserCreateConversation\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"integration\": {\n \"id\": \"5e4af71a81966cfff3ef6550\",\n \"type\": \"android\",\n \"status\": \"active\",\n \"displayName\": \"Android\",\n \"serverId\": \"<sender-id>\",\n \"canUserCreateMoreConversations\": true\n }\n}"
},
{
"id": "adb4998f-c795-4e73-8c58-ea7c2b90d249",
"name": "Integration 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\": \"My awesome integration\",\n \"serverKey\": \"<server-key>\",\n \"senderId\": \"<sender-id>\",\n \"canUserCreateConversation\": false\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"integrations",
":integrationId"
],
"variable": [
{
"key": "appId"
},
{
"key": "integrationId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
