CreateTourShiftInstanceConfig

POST

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

Creates the @tour_shift_instance_config for the org sending the request, returning @tour_shift_instance_config_sid.
The given @tour_shift_instance_config will not be created if it will overlap another tour shift instance config belonging to @tour_week_pattern_sid.
The @member_tour_shift_segment_configs field will be ignored, and will not be created if passed through this endpoint.
Errors:

grpc.Invalid: the request data is invalid or a preexisting tour shift instance config would overlap @tour_shift_instance_config.

grpc.Internal: error occurs when creating the data.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "tour_shift_instance_config": {
        "tour_shift_instance_config_sid": 0,
        "tour_week_pattern_sid": 0,
        "start_minute_in_week": 0,
        "width_in_minutes": 0,
        "member_tour_shift_segment_configs": [
            {
                "tour_shift_segment_config_sid": 0,
                "tour_shift_instance_config_sid": 0,
                "start_minute_in_shift": 0,
                "width_in_minutes": 0,
                "scheduling_activity_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/createtourshiftinstanceconfig' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tour_shift_instance_config": {
        "tour_shift_instance_config_sid": 0,
        "tour_week_pattern_sid": 0,
        "start_minute_in_week": 0,
        "width_in_minutes": 0,
        "member_tour_shift_segment_configs": [
            {
                "tour_shift_segment_config_sid": 0,
                "tour_shift_instance_config_sid": 0,
                "start_minute_in_shift": 0,
                "width_in_minutes": 0,
                "scheduling_activity_sid": 0
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "tour_shift_instance_config_sid": 0
}

🟢200Success

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

DeleteTourWeekPatterns

UpdateTourShiftInstanceConfig