UpdatePublishedShiftWithSegments

POST

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

Runs diagnostics on the given published @shift_instance for the org sending the request.
If @ignore_diagnostics_errors is True, the shift will be updated regardless of diagnostic errors and any diagnostics will be returned as warnings.
Otherwise, the shift will only be updated if there are no diagnostic errors.
Only the @start_datetime, @is_locked, @width_in_minutes and @wfm_agent_sid fields of the shift will be updated.

Any existing shift segments belonging to @shift_instance will be deleted and replaced with the ones in the given @shift_instance.
If no segments are provided, the existing segments will still be deleted and the instances will be left without any.
Can only update a shift on the published schedule. To update a draft shift use the UpdateShiftInstanceWithSegments endpoint.
Errors:

grpc.Invalid: the request data is invalid.

grpc.Internal: error occurs when updating the @shift_instance or replacing their member shift segments.

grpc.NotFound: @shift_instance_sid does 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/updatepublishedshiftwithsegments' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

UpdatePublishedShift

SplitPublishedShift