CopyScheduleToSchedule

POST

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

Copies the shifts from @source_schedule_selector to @destination_schedule_selector, constrained by the given parameters for the org sending the request.
If @datetime_range is set, all shifts within the datetime range will be copied.
If @datetime_range is not set, all shifts in the @source_schedule_selector within the schedule range of the @destination_schedule_selector will be copied. However if one of them is a published schedule, it will use the schedule range of the draft schedule.
If @start_datetimes_only is set to false, then shifts are considered to be within the @datetime range if any portion of them is within the range.
If @start_datetimes_only is set to true, then only shifts with start times within the @datetime range will be copied.
If @overlap_as_warning is set to false, any overlapping shifts for a given agent will return a diagnostic error, and prevent any shifts from being copied.
If @overlap_as_warning is set to true, the shifts will be copied regardless of overlap conflicts, and any conflicts will cause a diagnostic warning to be returned after.
Errors:
-grpc.Invalid: one or more fields in the request have invalid values.
-grpc.NotFound: the @source_schedule_selector or @destination_schedule_selector don't exist for the org sending the request.
-grpc.Internal: error occurs when creating the copied shift instances.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "source_schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "destination_schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "node_selector": {
        "parent_sid": 0,
        "parent_type": "CALL_CENTER_NODE"
    },
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "start_datetimes_only": true,
    "overlap_as_warning": 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/copyscheduletoschedule' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source_schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "destination_schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "node_selector": {
        "parent_sid": 0,
        "parent_type": "CALL_CENTER_NODE"
    },
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "start_datetimes_only": true,
    "overlap_as_warning": 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

ListShiftInstancesBySid

CreateShiftInstance