UpdateScheduleScenario

POST

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

Updates a schedule scenario corresponding to the given @schedule_scenario_sid and org sending the request with the provided parameters.
Only the @name, @description and @datetime_set_to_inactive fields may be updated, and must be filled in with current value if updating the field is not desired.
The @schedule_scenario_sid must be the original for the schedule scenario since it cannot be updated.
All other fields will be ignored since they cannot be updated.
Errors:
-grpc.Invalid: one or more fields in the @scenario have invalid values.
-grpc.NotFound: the scenario with the given @schedule_scenario_sid doesn't exist.
-grpc.Internal: error occurs when updating the scenario.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "scheduleScenario": {
        "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
    }
}

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/updateschedulescenario' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scheduleScenario": {
        "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
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

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

CreateScheduleScenarioWithNodes

ListConfigEntities