Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "username")
CkHttp::setCkPassword(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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"displayName","My awesome integration")
CkJsonObject::ckUpdateString(json,"serverKey","<server-key>")
CkJsonObject::ckUpdateString(json,"senderId","<sender-id>")
CkJsonObject::ckUpdateBool(json,"canUserCreateConversation",0)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://domain.com/v2/apps/{{appId}}/integrations/:integrationId",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
Id.s = CkJsonObject::ckStringOf(jResp,"integration.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"integration.type")
Status.s = CkJsonObject::ckStringOf(jResp,"integration.status")
DisplayName.s = CkJsonObject::ckStringOf(jResp,"integration.displayName")
ServerId.s = CkJsonObject::ckStringOf(jResp,"integration.serverId")
CanUserCreateMoreConversations.i = CkJsonObject::ckBoolOf(jResp,"integration.canUserCreateMoreConversations")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": ""
}
]
}