Chilkat Online Tools

Perl / Sunshine Conversations API / Update Switchboard

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.

# {
#   "enabled": false,
#   "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateBool("enabled",0);
$json->UpdateString("defaultSwitchboardIntegrationId","5ef21b132f21af34f088530e");

$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}}/switchboards/:switchboardId",$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)

# {
#   "switchboard": {
#     "id": "5ef21b132f21af34f088530d",
#     "enabled": true,
#     "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
#   }
# }

# 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("switchboard.id");
$Enabled = $jResp->BoolOf("switchboard.enabled");
$DefaultSwitchboardIntegrationId = $jResp->stringOf("switchboard.defaultSwitchboardIntegrationId");

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "enabled": false,
    "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
}'
https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId

Postman Collection Item JSON

{
  "name": "Update Switchboard",
  "_postman_id": "d495c4a8-de11-46e2-abb9-a859bb638b2e",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/switchboards/:switchboardId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "switchboards",
        ":switchboardId"
      ],
      "variable": [
        {
          "key": "switchboardId"
        }
      ]
    },
    "description": "Updates a switchboard record."
  },
  "response": [
    {
      "id": "8fadc082-59f3-4c73-975c-bb038c8e595d",
      "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    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"switchboard\": {\n  \"id\": \"5ef21b132f21af34f088530d\",\n  \"enabled\": true,\n  \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n }\n}"
    },
    {
      "id": "99204a68-10e3-470f-9508-e69ca7227660",
      "name": "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    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}