Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "username"
CkHttp_put_Password $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
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "displayName" "My awesome integration"
CkJsonObject_UpdateString $json "serverKey" "<server-key>"
CkJsonObject_UpdateString $json "senderId" "<sender-id>"
CkJsonObject_UpdateBool $json "canUserCreateConversation" 0
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PATCH" "https://domain.com/v2/apps/{{appId}}/integrations/:integrationId" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set Id [CkJsonObject_stringOf $jResp "integration.id"]
set v_Type [CkJsonObject_stringOf $jResp "integration.type"]
set Status [CkJsonObject_stringOf $jResp "integration.status"]
set DisplayName [CkJsonObject_stringOf $jResp "integration.displayName"]
set ServerId [CkJsonObject_stringOf $jResp "integration.serverId"]
set CanUserCreateMoreConversations [CkJsonObject_BoolOf $jResp "integration.canUserCreateMoreConversations"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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": ""
}
]
}