ListValidAgentsForReplacement

POST

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

Returns a list of @wfm_agent_sids that are suitable for replacing @wfm_agent_sid_to_replace for the given parameters and the org sending the request.
Only enforces that skill proficiencies are covered by the individual wfm agents, does not enforce constraint rules.
If @skip_skill_proficiency_sort is False, the agents will be returned in order of cumulative skill proficiency towards the required skills.
If @include_skill_mismatches is True, the agents will be included even if they do not include all of the required skills for the shifts being replaced.
If @skip_force_same_agent_groups is False, the agents will only be returned if they belong to every agent group that @wfm_agent_sid_to_replace is a member of. Otherwise, this check will be skipped.
Errors:

grpc.Invalid: the request data is invalid.

grpc.Internal: error occurs when determinining which agents are valid.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

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/listvalidagentsforreplacement' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

GenerateTourWeekPatterns

ReplaceAgentOnSchedule