Chilkat Online Tools

TCL / Sunshine Conversations API / Update Switchboard

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.

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

set json [new_CkJsonObject]

CkJsonObject_UpdateBool $json "enabled" 0
CkJsonObject_UpdateString $json "defaultSwitchboardIntegrationId" "5ef21b132f21af34f088530e"

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

# {
#   "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

set Id [CkJsonObject_stringOf $jResp "switchboard.id"]
set Enabled [CkJsonObject_BoolOf $jResp "switchboard.enabled"]
set DefaultSwitchboardIntegrationId [CkJsonObject_stringOf $jResp "switchboard.defaultSwitchboardIntegrationId"]

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