DeletePublishedShifts

POST

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

WFM

Deletes the published shift instances with the corresponding @shift_instance_sids for the org sending the request.
Only deletes published shifts. To delete draft shifts use the DeleteShiftInstances endpoint.
Errors:
-grpc.Invalid: the @shift_instance_sids are invalid for the org making the request.
-grpc.NotFound: the shift instances with the given @shift_instance_sids don't exist.
-grpc.Internal: error occurs when removing 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

Request message for the DeletePublishedShifts RPC.

shift_instance_sids

array[integer <int64> | string]

shift_instance_sids

optional

IDs of shift instances to delete.

Example

{
    "shift_instance_sids": [
        0
    ]
}

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/deletepublishedshifts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shift_instance_sids": [
        0
    ]
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-06-03 18:02:39

SwapPublishedShifts

ReplaceAgentOnPublishedSchedule