CreateScheduleScenarioWithNodes

POST

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

Creates a new schedule scenario for the org sending the request with the provided parameters.
The new @schedule_scenario_sid of the new entity will be returned in the response.
It also creates 1 of each of the following: call center, client, program, location node, and on call scheduling activity (if it doesn't exist already for the org).
The @node_description fields may optionally be left blank.
The @copied_from_scenario_sid field will be ignored, as it will be set to nil in the newly created scenario.
The @creation_datetime and @is_default fields will also be ignored and set as the current time and false respectively.
The @skill_profile_category will be associated with the created program node.
Errors:

grpc.Invalid: parameters in the @req are invalid for the org making the request.

grpc.NotFound: the @skill_profile_category does not exist.

grpc.Internal: error occurs when creating the new scenario, or any of the node entities.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "schedule_scenario": {
        "schedule_scenario_sid": 0,
        "name": "string",
        "description": "string",
        "creation_datetime": "1s",
        "created_by_user_id": "string",
        "is_default": true,
        "copied_from_scenario_sid": "string",
        "schedule_range": {
            "start_datetime": "1s",
            "end_datetime": "1s"
        },
        "datetime_set_to_inactive": "1s",
        "is_active": true
    },
    "call_center_node_name": "string",
    "call_center_node_description": "string",
    "client_node_name": "string",
    "client_node_description": "string",
    "location_node_name": "string",
    "location_node_description": "string",
    "program_node_name": "string",
    "program_node_description": "string",
    "time_zone_val": "TIME_ZONE_AMERICA_PUERTO_RICO",
    "skill_profile_category": {
        "skill_profile_category_sid": 0,
        "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
    }
}

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/createschedulescenariowithnodes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schedule_scenario": {
        "schedule_scenario_sid": 0,
        "name": "string",
        "description": "string",
        "creation_datetime": "1s",
        "created_by_user_id": "string",
        "is_default": true,
        "copied_from_scenario_sid": "string",
        "schedule_range": {
            "start_datetime": "1s",
            "end_datetime": "1s"
        },
        "datetime_set_to_inactive": "1s",
        "is_active": true
    },
    "call_center_node_name": "string",
    "call_center_node_description": "string",
    "client_node_name": "string",
    "client_node_description": "string",
    "location_node_name": "string",
    "location_node_description": "string",
    "program_node_name": "string",
    "program_node_description": "string",
    "time_zone_val": "TIME_ZONE_AMERICA_PUERTO_RICO",
    "skill_profile_category": {
        "skill_profile_category_sid": 0,
        "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "schedule_scenario_sid": 0
}

🟢200Success

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

CopyScenario

UpdateScheduleScenario