CopyShiftInstancesToSchedule

POST

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

Copies the given @shift_instance_sids to @destination_schedule for the org sending the request.
If there are any overlap conflicts on @destination_schedule and @overlap_as_warning is set to false,
then @shift_instance_sids will not be copied, and a list of diagnostics detailing the overlaps will be returned.
If @overlap_as_warning is set to true, overlap conflicts will not prevent the shifts from being copied, and the overlap diagnostics will be returned after as warning messages instead.
This endpoint can only copy shifts to a draft schedule. To copy shifts to the published schedule use the CopyShiftsToPublishedSchedule endpoint.
Errors:

grpc.Invalid: one or more fields in the request have invalid values.

grpc.NotFound: the @shift_instance_sids or @destination_schedule does not exist for the org sending the request.

grpc.Internal: error occurs when copying the shift instances.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "destination_schedule": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "shift_instance_sids": [
        0
    ],
    "overlap_as_warning": true,
    "source_schedule_type": "DRAFT"
}

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/copyshiftinstancestoschedule' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "destination_schedule": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "shift_instance_sids": [
        0
    ],
    "overlap_as_warning": true,
    "source_schedule_type": "DRAFT"
}'

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

UpdateShiftInstanceWithSegments

ListShiftInstanceSidsForAgent