CreateShiftInstanceV2

POST

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

Creates a shift instance for the org sending the request with the provided parameters.
If @wfm_agent_sids is empty, then the shift instance will be created for a newly created unassigned agent.
A shift instance will be created for each wfm agent sid provided.
Can only create shifts for the draft schedule. Published shifts require the CreatePublishedShift endpoint.
Errors:

grpc.Invalid: one or more fields in the request have invalid values.

grpc.Internal: error occurs when creating the shift instance.

grpc.NotFound: the @draft_schedule_sid, @shift_template_sid, or @wfm_agent_sids do not exist for the org sending the request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

CreateShiftInstance

CreateShiftInstanceWithSegments