ResetDraftSchedule

POST

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

Resets the shifts on the @draft_schedule_sid for the org sending the request.
Shifts overlapping the @datetime_range will be deleted, then that @datetime_range will be populated with shifts from the published schedule.
If no @datetime_range is provided, all shifts will be removed from the @draft_schedule_sid, and published shifts will be copied across the draft's datetime range.
If @unlocked_only is set to true, only unlocked shifts will be deleted, and the locked shift instances will remain.
The published schedule will still be copied, so any newly overlapping shifts will result in an overlap warning.
Errors:

grpc.Invalid: the @datetime_range or @draft_schedule_sid are invalid for the org sending the request.

grpc.NotFound: the @draft_schedule_sid doesn't exist.

grpc.Internal: error occurs when resetting the schedule.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "draft_schedule_sid": 0,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "unlocked_only": true
}

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/resetdraftschedule' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "draft_schedule_sid": 0,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "unlocked_only": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "diagnostics": [
        {
            "level": "INFORMATION",
            "code": "GENERAL",
            "message": "string",
            "source_entity": {
                "parent_sid": 0,
                "parent_type": "CALL_CENTER_NODE"
            }
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

PublishDraftSchedule

GetDraftSchedule