UpdateAdherenceAgentRuleClause

POST

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

WFM

Updates the given adherence agent rule @clause for the org sending the request.
Fields that can be updated are: action_type, condition, amount, unit.
Errors:

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

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

grpc.NotFound: agent rule with the with @adherence_agent_rule_clause_id does not exist to update.

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 UpdateAdherenceAgentRuleClause.

clause

object (AdherenceAgentRuleClause)

clause

optional

Agent rule clause to update.

action

object (AdherenceAgentRuleAction)

action

optional

Action that this agent rule clause evaluates.

condition

enum<string>

condition

optional

Condition that will be evaluated between the @action and the @amount.

Allowed values:

ADHERENCE_RULE_CONDITION_GREATER_THANADHERENCE_RULE_CONDITION_GREATER_THAN_EQUALADHERENCE_RULE_CONDITION_LESS_THANADHERENCE_RULE_CONDITION_LESS_THAN_EQUAL

unit

enum<string>

unit

optional

Unit that the @amount is on.

Allowed values:

ADHERENCE_RULE_UNIT_SECONDSADHERENCE_RULE_UNIT_MINUTESADHERENCE_RULE_UNIT_CALLSADHERENCE_RULE_UNIT_PERCENTAGE

amount

integer <int32>

amount

optional

Amount to evaluate.

adherence_agent_rule_clause_id

integer <int64> | string

adherence_agent_rule_clause_id

optional

ID of this agent rule clause.

adherence_agent_rule_id

integer <int64> | string

adherence_agent_rule_id

optional

ID of the agent rule that this clause belongs to.

Example

{
  "clause": {
    "action": {
      "action_type": "ADHERENCE_AGENT_RULE_ACTION_TYPE_WRAP_UP"
    },
    "condition": "ADHERENCE_RULE_CONDITION_GREATER_THAN",
    "unit": "ADHERENCE_RULE_UNIT_SECONDS",
    "amount": 0,
    "adherence_agent_rule_clause_id": 0,
    "adherence_agent_rule_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/updateadherenceagentruleclause' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clause": {
        "action": {
            "action_type": "ADHERENCE_AGENT_RULE_ACTION_TYPE_WRAP_UP"
        },
        "condition": "ADHERENCE_RULE_CONDITION_GREATER_THAN",
        "unit": "ADHERENCE_RULE_UNIT_SECONDS",
        "amount": 0,
        "adherence_agent_rule_clause_id": 0,
        "adherence_agent_rule_id": 0
    }
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-04-18 19:29:54

CreateAdherenceAgentRuleClause

ListAdherenceAgentRules