Chilkat Online Tools

Perl / Sunshine Conversations API / Update Integration

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("username");
$http->put_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": "My awesome integration",
#   "serverKey": "<server-key>",
#   "senderId": "<sender-id>",
#   "canUserCreateConversation": false
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("displayName","My awesome integration");
$json->UpdateString("serverKey","<server-key>");
$json->UpdateString("senderId","<sender-id>");
$json->UpdateBool("canUserCreateConversation",0);

$http->SetRequestHeader("Content-Type","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PATCH","https://domain.com/v2/apps/{{appId}}/integrations/:integrationId",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# 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 = $jResp->stringOf("integration.id");
$v_Type = $jResp->stringOf("integration.type");
$Status = $jResp->stringOf("integration.status");
$DisplayName = $jResp->stringOf("integration.displayName");
$ServerId = $jResp->stringOf("integration.serverId");
$CanUserCreateMoreConversations = $jResp->BoolOf("integration.canUserCreateMoreConversations");

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": ""
    }
  ]
}