SplitShiftInstance

POST

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

Splits the @shift_instance_sid into two, at the given @time_to_split, returning the updated and new @shift_instances.
Any shift segments will be split between the two shift instances at @time_to_split.
If the @time_to_split creates instances shorter then the minimum length specified by the shift template,
warning diagnostics will be returned and the instance will still be split.
Can only split a shift on the draft schedule. To split a published shift use the SplitPublishedShift endpoint.
Errors:
-grpc.Invalid: one or more fields in the request have invalid values, or @time_to_split is not at least 5 minutes from the start or end of @shift_instance_sid.
-grpc.NotFound: the @shift_instance_sid does't exist for the org sending the request.
-grpc.Internal: error occurs when creating or updating the shift instances.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

No schema defined

Example

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

Responses

🟢200OK

application/json

Success

Body

No schema defined

Example

🔴500Server Error

Modified at 2025-07-22 23:08:25

CreateShiftInstanceWithSegments

SwapShiftInstances