SwapShiftInstances

Swaps shift instances with the given @shift_instance_sids that belong to @wfm_agent_sid1 to belong to @wfm_agent_sid2 (and viceversa).
Returns the swapped @shift_instances after they are succesfully updated.
If there are other shifts for the given @wfm_agent_sids with an overlap conflict, diagnostics will be returned instead.
All @shift_instance_sids must belong to the same schedule, and be from a draft schedule.
Is only capable of swapping shifts on the draft schedule. To include shifts on the published schedule use the SwapPublishedShifts endpoint.
If there is an overlap conflict with the swap, a diagnostic will be returned and the shifts will not be updated.
Errors:
grpc.Invalid: one or more fields in the request have invalid values, or one of the @shift_instance_sids does not belong to either @wfm_agent_sid_1 nor @wfm_agent_sid_2 or is on a published schedule.
grpc.NotFound: @wfm_agent_sid_1, @wfm_agent_sid_2, or @shift_instance_sids do not exist for the org sending the request.
grpc.Internal: error occurs when swapping the shift instances.
Request Code Samples
Shell
JavaScript
Java
Swift
PHP
Python
HTTP
Objective-C
Ruby
OCaml
Dart
Responses
🟢200OK
application/json
Success
Body
Example
{
    "shift_instances": [
        {
            "shift_instance_sid": 0,
            "start_datetime": "1s",
            "is_locked": true,
            "width_in_minutes": 0,
            "shift_template_sid": 0,
            "originating_program_node_sid": 0,
            "schedule_sid": 0,
            "wfm_agent_sid": 0,
            "schedule_type": "DRAFT",
            "shift_segments": [
                {
                    "shift_segment_sid": 0,
                    "shift_instance_sid": 0,
                    "order_in_shift_instance": 0,
                    "width_in_minutes": 0,
                    "start_minute_in_shift": 0,
                    "scheduling_activity_sid": 0,
                    "scheduling_activity": {
                        "scheduling_activity_sid": 0,
                        "is_skill_activity": true,
                        "activity_sid": "string",
                        "member_non_skill_activity": {
                            "non_skill_activity_sid": 0,
                            "name": "string",
                            "description": "string",
                            "datetime_set_to_inactive": "1s",
                            "red": 0,
                            "green": 0,
                            "blue": 0,
                            "transparency": 0,
                            "inherited_from_entity": {
                                "parent_sid": 0,
                                "parent_type": "CALL_CENTER_NODE"
                            }
                        },
                        "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                        "pause_codes": [
                            "string"
                        ],
                        "reason_codes": [
                            {
                                "reason_code_id": 0,
                                "name": "string",
                                "scheduling_activity_sid": 0,
                                "is_planned": true,
                                "is_paid": true,
                                "is_default": true,
                                "datetime_set_to_inactive": "1s"
                            }
                        ]
                    },
                    "call_stats_by_skill_collection": [
                        {
                            "num_calls": 0,
                            "percent_fit": 0,
                            "skill_collection": {
                                "skill_profile_category_sid": 0,
                                "skill_profile_category_type": "SINGLE_SKILL_PROFILE"
                            }
                        }
                    ],
                    "reason_code_id": 0
                }
            ],
            "shift_template": {
                "shift_template_sid": 0,
                "program_node_sid": 0,
                "name": "string",
                "description": "string",
                "datetime_set_to_inactive": "1s",
                "is_tourshift": true,
                "min_shift_width": 0,
                "max_shift_width": 0,
                "min_agents": 0,
                "max_agents": 0,
                "shift_start_boundary_minutes": 0,
                "same_time_each_DOW": true,
                "same_length_per_agent": true,
                "schedule_scenario_sid": 0,
                "member_placement_rules": [
                    {
                        "placement_rule_sid": 0,
                        "shift_template_sid": 0,
                        "activity_order": 0,
                        "min_duration_minutes": 0,
                        "max_duration_minutes": 0,
                        "scheduling_activity_sid": 0,
                        "schedule_scenario_sid": 0,
                        "member_scheduling_activity": {
                            "scheduling_activity_sid": 0,
                            "is_skill_activity": true,
                            "activity_sid": "string",
                            "member_non_skill_activity": {
                                "non_skill_activity_sid": 0,
                                "name": "string",
                                "description": "string",
                                "datetime_set_to_inactive": "1s",
                                "red": 0,
                                "green": 0,
                                "blue": 0,
                                "transparency": 0,
                                "inherited_from_entity": {
                                    "parent_sid": 0,
                                    "parent_type": "CALL_CENTER_NODE"
                                }
                            },
                            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                            "pause_codes": [
                                "string"
                            ],
                            "reason_codes": [
                                {
                                    "reason_code_id": 0,
                                    "name": "string",
                                    "scheduling_activity_sid": 0,
                                    "is_planned": true,
                                    "is_paid": true,
                                    "is_default": true,
                                    "datetime_set_to_inactive": "1s"
                                }
                            ]
                        }
                    }
                ],
                "DOW_placements": [
                    {
                        "start_minute": 0,
                        "end_minute": 0,
                        "placement_type": "MUST_NOT",
                        "day_of_week": "MON",
                        "week_number": 0
                    }
                ],
                "member_agent_groups": [
                    {
                        "agent_group_sid": 0,
                        "parent_entity": {
                            "parent_sid": 0,
                            "parent_type": "CALL_CENTER_NODE"
                        },
                        "name": "string",
                        "description": "string",
                        "datetime_set_to_inactive": "1s",
                        "schedule_scenario_sid": 0,
                        "member_constraint_rules": [
                            {
                                "scheduling_activity": {
                                    "scheduling_activity_sid": 0,
                                    "is_skill_activity": true,
                                    "activity_sid": "string",
                                    "member_non_skill_activity": {
                                        "non_skill_activity_sid": 0,
                                        "name": "string",
                                        "description": "string",
                                        "datetime_set_to_inactive": "1s",
                                        "red": 0,
                                        "green": 0,
                                        "blue": 0,
                                        "transparency": 0,
                                        "inherited_from_entity": {
                                            "parent_sid": 0,
                                            "parent_type": "CALL_CENTER_NODE"
                                        }
                                    },
                                    "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                                    "pause_codes": [
                                        "string"
                                    ],
                                    "reason_codes": [
                                        {
                                            "reason_code_id": 0,
                                            "name": "string",
                                            "scheduling_activity_sid": 0,
                                            "is_planned": true,
                                            "is_paid": true,
                                            "is_default": true,
                                            "datetime_set_to_inactive": "1s"
                                        }
                                    ]
                                }
                            }
                        ],
                        "member_wfm_agents": [
                            {
                                "wfm_agent_sid": 0,
                                "tcn_agent_sid": "string",
                                "name": "string",
                                "datetime_set_to_inactive": "1s",
                                "member_constraint_rules": [
                                    {
                                        "scheduling_activity": {
                                            "scheduling_activity_sid": 0,
                                            "is_skill_activity": true,
                                            "activity_sid": "string",
                                            "member_non_skill_activity": {
                                                "non_skill_activity_sid": 0,
                                                "name": "string",
                                                "description": "string",
                                                "datetime_set_to_inactive": "1s",
                                                "red": 0,
                                                "green": 0,
                                                "blue": 0,
                                                "transparency": 0,
                                                "inherited_from_entity": {
                                                    "parent_sid": 0,
                                                    "parent_type": "CALL_CENTER_NODE"
                                                }
                                            },
                                            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                                            "pause_codes": [
                                                "string"
                                            ],
                                            "reason_codes": [
                                                {
                                                    "reason_code_id": 0,
                                                    "name": "string",
                                                    "scheduling_activity_sid": 0,
                                                    "is_planned": true,
                                                    "is_paid": true,
                                                    "is_default": true,
                                                    "datetime_set_to_inactive": "1s"
                                                }
                                            ]
                                        }
                                    }
                                ],
                                "member_skill_proficiencies": [
                                    {
                                        "skill_proficiency_sid": 0,
                                        "skill_sid": 0,
                                        "preferred_skill_profile_sid": "string",
                                        "manual_proficiency_value": 0,
                                        "parent_entity": {
                                            "parent_sid": 0,
                                            "parent_type": "CALL_CENTER_NODE"
                                        },
                                        "skill_name": "string",
                                        "skill_profile_name": "string",
                                        "skill_profile_proficiency_value": 0
                                    }
                                ],
                                "member_agent_availability_patterns": [
                                    {
                                        "agent_availability_pattern_sid": 0,
                                        "parent_entity": {
                                            "parent_sid": 0,
                                            "parent_type": "CALL_CENTER_NODE"
                                        },
                                        "datetime_pattern": {
                                            "week_maps": [
                                                {
                                                    "datetime_range": {
                                                        "start_datetime": "1s",
                                                        "end_datetime": "1s"
                                                    },
                                                    "day_maps": [
                                                        {}
                                                    ]
                                                }
                                            ],
                                            "calendar_items": [
                                                {
                                                    "datetime_range": {
                                                        "start_datetime": "1s",
                                                        "end_datetime": "1s"
                                                    },
                                                    "value": {
                                                        "availability_option": "AVAILABLE"
                                                    }
                                                }
                                            ]
                                        },
                                        "schedule_scenario_sid": 0,
                                        "scheduling_activity_sid": "string"
                                    }
                                ],
                                "created_at": "1s",
                                "tcn_agent_is_enabled": true
                            }
                        ],
                        "member_skill_proficiencies": [
                            {
                                "skill_proficiency_sid": 0,
                                "skill_sid": 0,
                                "preferred_skill_profile_sid": "string",
                                "manual_proficiency_value": 0,
                                "parent_entity": {
                                    "parent_sid": 0,
                                    "parent_type": "CALL_CENTER_NODE"
                                },
                                "skill_name": "string",
                                "skill_profile_name": "string",
                                "skill_profile_proficiency_value": 0
                            }
                        ],
                        "member_agent_availability_patterns": [
                            {
                                "agent_availability_pattern_sid": 0,
                                "parent_entity": {
                                    "parent_sid": 0,
                                    "parent_type": "CALL_CENTER_NODE"
                                },
                                "datetime_pattern": {
                                    "week_maps": [
                                        {
                                            "datetime_range": {
                                                "start_datetime": "1s",
                                                "end_datetime": "1s"
                                            },
                                            "day_maps": [
                                                {
                                                    "day_of_week": "MON",
                                                    "start_minute_in_day": 0,
                                                    "end_minute_in_day": 0,
                                                    "value": {
                                                        "availability_option": "AVAILABLE"
                                                    }
                                                }
                                            ]
                                        }
                                    ],
                                    "calendar_items": [
                                        {
                                            "datetime_range": {
                                                "start_datetime": "1s",
                                                "end_datetime": "1s"
                                            },
                                            "value": {
                                                "availability_option": "AVAILABLE"
                                            }
                                        }
                                    ]
                                },
                                "schedule_scenario_sid": 0,
                                "scheduling_activity_sid": "string"
                            }
                        ]
                    }
                ]
            },
            "planned_shrinkage_percent": 0
        }
    ],
    "diagnostics": [
        {
            "level": "INFORMATION",
            "code": "GENERAL",
            "message": "string",
            "source_entity": {
                "parent_sid": 0,
                "parent_type": "CALL_CENTER_NODE"
            }
        }
    ]
}
🟢200Success