SwapShiftInstances

POST

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

Swaps shift instances with the given @shift_instance_sids that belong to @wfm_agent_sid1 to belong to @wfm_agent_sid2 (and viceversa).
Returns the swapped @shift_instances after they are succesfully updated.
If there are other shifts for the given @wfm_agent_sids with an overlap conflict, diagnostics will be returned instead.
All @shift_instance_sids must belong to the same schedule, and be from a draft schedule.
Is only capable of swapping shifts on the draft schedule. To include shifts on the published schedule use the SwapPublishedShifts endpoint.
If there is an overlap conflict with the swap, a diagnostic will be returned and the shifts will not be updated.
Errors:

grpc.Invalid: one or more fields in the request have invalid values, or one of the @shift_instance_sids does not belong to either @wfm_agent_sid_1 nor @wfm_agent_sid_2 or is on a published schedule.

grpc.NotFound: @wfm_agent_sid_1, @wfm_agent_sid_2, or @shift_instance_sids do not exist for the org sending the request.

grpc.Internal: error occurs when swapping 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

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

SplitShiftInstance

UpdateShiftInstance