UpdateDashboardGeneralPreferences

POST

https://api.cbf.tcn.com/api/v0alpha/org/preferences/reports/dashboard/update

UpdateDashboardGeneralPreferences updates dashboard General preferences for an org.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for UpdateDashboardGeneralPreferences

dashboard_preferences

object (DashboardPreferences)

dashboard_preferences

optional

Dashboard preferences object, required to update

default_call_types

object (IncludedCallTypes)

default_call_types

optional

Which call types are enabled in the agents dashboard

default_info_sort_by_value

enum<string>

default_info_sort_by_value

optional

Agent info dashboard order-by parameter

Allowed values:

AGENT_INFO_SORT_BY_NONEAGENT_INFO_SORT_BY_AGENTAGENT_INFO_SORT_BY_AGENT_LAST_NAMEAGENT_INFO_SORT_BY_AGENT_STATUS_SIMPLIFIERAGENT_INFO_SORT_BY_CALL_COUNTAGENT_INFO_SORT_BY_SECONDS_SINCE_STATUS_CHANGEAGENT_INFO_SORT_BY_HUNT_GROUP_NAMEAGENT_INFO_SORT_BY_HUNT_GROUP_SIDAGENT_INFO_SORT_BY_SESSION_LOGIN_TIMEAGENT_INFO_SORT_BY_MULTI_HOLD_COUNTAGENT_INFO_SORT_BY_SIMPLE_HOLD_COUNTAGENT_INFO_SORT_BY_HOLD_COUNT

default_barge_in_filtering

object (BargeInFiltering)

default_barge_in_filtering

optional

Barge-in agent filter, controls hunt-group and agent status parameters

default_info_view

boolean

default_info_view

optional

Default agent dashboard view; false for icon view, true for table view.

default_table_inclusion

boolean

default_table_inclusion

optional

Include all agents in table by default.

default_info_grouping

boolean

default_info_grouping

optional

Group agent info by hunt group by default.

default_small_icon

boolean

default_small_icon

optional

Agent icon size; false for large, true for small.

default_descending_sort

boolean

default_descending_sort

optional

Agent dashboard sort direction; false for ascending, true for descending.

table_template_sid

integer <int64> | string

table_template_sid

optional

xml_client_property_sid associated with the agent dashboard table template property.

field_mask

string

field_mask

optional

Field mask for update request

Example

{
    "dashboard_preferences": {
        "default_call_types": {
            "outbound": true,
            "inbound": true,
            "manual_dial": true,
            "preview_dial": true
        },
        "default_info_sort_by_value": "AGENT_INFO_SORT_BY_NONE",
        "default_barge_in_filtering": {
            "hunt_group": {
                "any": true,
                "hunt_group_sid": 0
            },
            "agent_status": {
                "any": true,
                "waiting": true,
                "on_call": true,
                "wrap_up": true,
                "paused": true,
                "transfer": true,
                "preview": true,
                "manual": true,
                "pbx": true,
                "intercom": true
            }
        },
        "default_info_view": true,
        "default_table_inclusion": true,
        "default_info_grouping": true,
        "default_small_icon": true,
        "default_descending_sort": true,
        "table_template_sid": 0
    },
    "field_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/org/preferences/reports/dashboard/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dashboard_preferences": {
        "default_call_types": {
            "outbound": true,
            "inbound": true,
            "manual_dial": true,
            "preview_dial": true
        },
        "default_info_sort_by_value": "AGENT_INFO_SORT_BY_NONE",
        "default_barge_in_filtering": {
            "hunt_group": {
                "any": true,
                "hunt_group_sid": 0
            },
            "agent_status": {
                "any": true,
                "waiting": true,
                "on_call": true,
                "wrap_up": true,
                "paused": true,
                "transfer": true,
                "preview": true,
                "manual": true,
                "pbx": true,
                "intercom": true
            }
        },
        "default_info_view": true,
        "default_table_inclusion": true,
        "default_info_grouping": true,
        "default_small_icon": true,
        "default_descending_sort": true,
        "table_template_sid": 0
    },
    "field_mask": "string"
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-07-10 17:42:28

GetDashboardGeneralPreferences

GetWebhookPreferences