SetSchedulingTarget

POST

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

Creates the given @scheduling_target for the org making the request.
The @scheduling_target_sid of the new entity will be returned in the response.
Any preexisting scheduling target for @node_entity will be removed upon creation of the new @scheduling_target.
Errors:

grpc.Invalid: the @scheduling_target is invalid.

grpc.NotFound: @node_entity doesn't exist for @schedule_scenario_sid and the org making the request.

grpc.Internal: error occours when setting the scheduling target.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "scheduling_target": {
        "scheduling_target_sid": 0,
        "scheduling_target_type": "COVERAGE",
        "scheduling_target_percentage": 0,
        "service_level_target_duration_seconds": "string",
        "node_entity": {
            "parent_sid": 0,
            "parent_type": "CALL_CENTER_NODE"
        }
    },
    "schedule_scenario_sid": 0
}

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/setschedulingtarget' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scheduling_target": {
        "scheduling_target_sid": 0,
        "scheduling_target_type": "COVERAGE",
        "scheduling_target_percentage": 0,
        "service_level_target_duration_seconds": "string",
        "node_entity": {
            "parent_sid": 0,
            "parent_type": "CALL_CENTER_NODE"
        }
    },
    "schedule_scenario_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "scheduling_target_sid": 0
}

🟢200Success

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

ListShiftSegmentsByShiftInstanceSids

GetSchedulingTarget