UpdateAdherenceDepartmentalRule

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/updateadherencedepartmentalrule

Updates the given adherence departmental @rule for the org sending the request.
Fields that can be updated are: name, selected_entity_id, selected_entity_type, rule_requirement_type,
rule_range, custom_range, adherence_rule_notification_config_id.
Errors:

grpc.Invalid: the values on the given @rule are invalid.

grpc.NotFound: departmental rule clause with @adherence_departmental_rule_clause_id does not exist.

grpc.Internal: error occurs when updating the given @rule.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for UpdateAdherenceDepartmentalRule.

rule

object (AdherenceDepartmentalRule)

rule

optional

Departmental rule to update.

selected_entity

object (ConfigEntity)

selected_entity

optional

Config entity that the rule applies to, supported ones are:
CALL_CENTER_NODE, CLIENT_NODE, LOCATION_NODE, PROGRAM_NODE, SHIFT_TEMPLATE, AGENT_GROUP.

rule_requirement_type

enum<string>

rule_requirement_type

optional

Specifies the requirement type of this rule.

Allowed values:

ADHERENCE_RULE_REQUIREMENT_TYPE_NOT_USEDADHERENCE_RULE_REQUIREMENT_TYPE_OPTIONALADHERENCE_RULE_REQUIREMENT_TYPE_MANDATORY

rule_range

enum<string>

rule_range

optional

Range that this rule will be applied at.

Allowed values:

ADHERENCE_RULE_RANGE_START_OF_DAYADHERENCE_RULE_RANGE_START_OF_WEEKADHERENCE_RULE_RANGE_START_OF_MONTHADHERENCE_RULE_RANGE_REST_OF_DAYADHERENCE_RULE_RANGE_CUSTOM_DATE_RANGE

custom_range

object (DatetimeRange)

custom_range

optional

Custom date range to apply the rule, must only be set when @rule_range is CUSTOM_DATE_RANGE.

name

string

name

optional

Name of this departmental rule.

rule_clauses

array[object (AdherenceDepartmentalRuleClause) {8}]

rule_clauses

optional

Clauses that belong to this rule. Only used by List methods.

adherence_departmental_rule_id

integer <int64> | string

adherence_departmental_rule_id

optional

ID of this departmental rule.

adherence_rule_notification_config_id

integer <int64> | string

adherence_rule_notification_config_id

optional

ID of the notification config that this rule will use/follow.

Example

{
    "rule": {
        "selected_entity": {
            "entity_type": "CALL_CENTER_NODE",
            "entity_sid": 0
        },
        "rule_requirement_type": "ADHERENCE_RULE_REQUIREMENT_TYPE_NOT_USED",
        "rule_range": "ADHERENCE_RULE_RANGE_START_OF_DAY",
        "custom_range": {
            "start_datetime": "1s",
            "end_datetime": "1s"
        },
        "name": "string",
        "rule_clauses": [
            {
                "action": {
                    "action_type": "ADHERENCE_DEPARTMENTAL_RULE_ACTION_TYPE_CALLS_ANSWERED"
                },
                "condition": "ADHERENCE_RULE_CONDITION_GREATER_THAN",
                "unit": "ADHERENCE_RULE_UNIT_SECONDS",
                "per_amount": 0,
                "per_unit": "ADHERENCE_RULE_UNIT_SECONDS",
                "amount": 0,
                "adherence_departmental_rule_clause_id": 0,
                "adherence_departmental_rule_id": 0
            }
        ],
        "adherence_departmental_rule_id": 0,
        "adherence_rule_notification_config_id": 0
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/updateadherencedepartmentalrule' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rule": {
        "selected_entity": {
            "entity_type": "CALL_CENTER_NODE",
            "entity_sid": 0
        },
        "rule_requirement_type": "ADHERENCE_RULE_REQUIREMENT_TYPE_NOT_USED",
        "rule_range": "ADHERENCE_RULE_RANGE_START_OF_DAY",
        "custom_range": {
            "start_datetime": "1s",
            "end_datetime": "1s"
        },
        "name": "string",
        "rule_clauses": [
            {
                "action": {
                    "action_type": "ADHERENCE_DEPARTMENTAL_RULE_ACTION_TYPE_CALLS_ANSWERED"
                },
                "condition": "ADHERENCE_RULE_CONDITION_GREATER_THAN",
                "unit": "ADHERENCE_RULE_UNIT_SECONDS",
                "per_amount": 0,
                "per_unit": "ADHERENCE_RULE_UNIT_SECONDS",
                "amount": 0,
                "adherence_departmental_rule_clause_id": 0,
                "adherence_departmental_rule_id": 0
            }
        ],
        "adherence_departmental_rule_id": 0,
        "adherence_rule_notification_config_id": 0
    }
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

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

CreateAdherenceDepartmentalRule

CreateAdherenceDepartmentalRuleClause