SetAgentStateSimulationLevelForOrg

POST

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

Sets the adherence service to the @agent_state_simulation_level for the org sending the request.
By setting the @agent_state_simulation_level to NO_SIMULATION, the adherence manager will function normally, using the live agent states.
By setting the @agent_state_simulation_level to SIMULATED_AGENT_STATES, the adherence manager will instead simulate agent states and their violations.
This allows demonstrations of the adherence functions of the app to be done before the client has any agents working.
Errors:

grpc.Invalid: the given @agent_state_simulation_level is invalid

grpc.Internal: error occurs when updating the simulation level for the org sending the request.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "agent_state_simulation_level": "NO_SIMULATION"
}

Request Code 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/setagentstatesimulationlevelfororg' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agent_state_simulation_level": "NO_SIMULATION"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

Modified at 2025-09-26 15:44:58

AgentCancelLeavePetition

GetWorkflowDefinition