UpdatePublishedShift

Updates a shift instance on the published schedule for the org sending the request with the provided parameters.
Can only update a shift on the published schedule. To update a draft shift use the UpdateShiftInstanceV2 endpoint.
If the width of the shift is changed, the lengths of the shift segments will be adjusted proportionally.
Errors:

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

grpc.Internal: error occurs when updating the shift instance.

grpc.NotFound: @shift_instance_sid does not exist for the org sending the request.

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 UpdatePublishedShift RPC.

start_datetime

string <date-time>

start_datetime

optional

The new start time for the updated shift instance.

Examples:

1s1.000340012s

width_in_minutes

integer <int32>

width_in_minutes

optional

The width of the updated shift instance

is_locked

boolean

is_locked

optional

If true, locks @shift_instance_sid, so that it may not be updated again without being unlocked.
if true and the shift instance already is locked, the instance will not have any fields updated.
If false, will unlock a currently locked shift instance and allow it to be updated.

planned_shrinkage_percent

number <float>

planned_shrinkage_percent

optional

the percentage shrinkage expected for this shift [0.0, 100.0]. 0.0 = no shrinkage, 100 = no agents

shift_instance_sid

integer <int64> | string

shift_instance_sid

optional

ID of the shift instance to update.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

The updated wfm agent to be assigned to @shift_segment_sid.

Example

{
  "start_datetime": "1s",
  "width_in_minutes": 0,
  "is_locked": true,
  "planned_shrinkage_percent": 0,
  "shift_instance_sid": 0,
  "wfm_agent_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the UpdatePublishedShift RPC.

shift_instance

object (ShiftInstance)

shift_instance

optional

The updated shift instance.

start_datetime

string <date-time>

start_datetime

optional

The start time for this shift instance

Examples:

1s1.000340012s

schedule_type

enum<string>

schedule_type

optional

Type of schedule that this shift instance belongs to.

Allowed values:

DRAFTPUBLISHED

shift_template

object (ShiftTemplate)

shift_template

optional

The shift template used to create this shift instance.

is_locked

boolean

is_locked

optional

Tells the scheduler to leave this instance in tact when performing 'build schedule'.
If set to false, the instance will not be locked and may be lost when a new schedule is built.

width_in_minutes

integer <int32>

width_in_minutes

optional

The duration of this shift instance in minutes.

shift_segments

array[object (ShiftSegment) {9}]

shift_segments

optional

The following field is only returned in List requests of the entity.
The ordered set of shift segments for this shift instance.

planned_shrinkage_percent

number <float>

planned_shrinkage_percent

optional

the percentage shrinkage expected for this shift [0.0, 100.0]. 0.0 = no shrinkage, 100 = no agents

shift_instance_sid

integer <int64> | string

shift_instance_sid

optional

ID of the shift instance.

shift_template_sid

integer <int64> | string

shift_template_sid

optional

ID of shift template that this shift instance belongs to.

originating_program_node_sid

integer <int64> | string

originating_program_node_sid

deprecated

ID of the program node that the shift instance belongs to, which may be different that the one that the @parent_shift_template_sid belongs to.

schedule_sid

integer <int64> | string

schedule_sid

optional

ID of the schedule that this shift instance belongs to.
May either point to a published or draft schedule.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID for the wfm agent that is scheduled to this shift.

diagnostics

array[object (Diagnostic) {4}]

diagnostics

optional

A list of diagnostics for any errors encountered, which prevented the update.

level

enum<string>

level

optional

The diagnostic level describes the class of the diagnostic message.

Allowed values:

INFORMATIONSUGGESTIONWARNINGDIAGNOSTIC_ERRORINTERNAL_ERROR

code

enum<string>

code

optional

A code to describe the diagnostic when possible. Default value of General when a more specific code is not available.

Allowed values:

GENERALOKNO_SKILLS_IN_DICTIONARYAGENT_HAS_NO_SKILL_PROFICIENCIESAGENT_HAS_NO_SKILLSNO_SCHEDULING_ACTIVITIES_FOR_CONSTRAINT_RULESSCHEDULING_ACTIVITY_FOR_CONSTRAINT_RULE_NOT_FOUNDSHIFT_TEMPLATE_CANNOT_BE_NONESHIFT_TEMPLATE_HAS_NO_PLACEMENT_RULESNO_ONCALL_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_DURATION_IN_SHIFT_TEMPLATE_PLACEMENT_RULESMIN_GT_MAX_AGENTS_IN_SHIFT_TEMPLATENO_PLACEMENT_RULES_FOR_SHIFT_TEMPLATEACTIVITIES_SHORTER_THAN_SHIFTNOT_ENOUGH_AGENTS_FOR_SHIFTPROGRAM_HAS_NO_AGENT_GROUPSPROGRAM_HAS_NO_SHIFT_TEMPLATESLOCATION_HAS_NO_PROGRAMSCLIENT_HAS_NO_LOCATIONSCALL_CENTER_HAS_NO_CLIENTSPROGRAM_HAS_INVALID_PARENT_LOCATIONLOCATION_HAS_INVALID_PARENT_CLIENTCLIENT_HAS_INVALID_PARENT_CALL_CENTERAGENT_GROUP_HAS_INVALID_PARENT_NODESHIFT_TEMPLATE_HAS_INVALID_PARENT_PROGRAMNO_SKILL_PROFICIENCY_FOR_MIN_SKILL_PROFICIENCY_CONSTRAINT_RULETOO_MANY_AGENTS_WITH_LOCKED_SHIFTS_FOR_MIN_AGENTSAGENT_DOES_NOT_BELONG_TO_AN_AGENT_GROUPINVALID_CONSTRAINT_VAL_UNITSCONSTRAINT_GENERAL_FAILURECANDIDATE_SHIFT_COLLISION_DETECTEDCANDIDATE_SHIFT_AGENT_NOT_AVAILABLECANDIDATE_CLOSEDCONSTRAINT_ACTIVITY_NOT_FOUNDCONSTRAINT_AGENT_DOES_NOT_HAVE_PROFICIENCYCONSTRAINT_AGENT_PROFICIENCY_TOO_LOWCONSTRAINT_MAX_TOTAL_ON_FAILURECONSTRAINT_MIN_TOTAL_ON_FAILURECONSTRAINT_MAX_TOTAL_OFF_FAILURECONSTRAINT_MIN_TOTAL_OFF_FAILURECONSTRAINT_MAX_CONSEC_ON_FAILURECONSTRAINT_MIN_CONSEC_ON_FAILURECONSTRAINT_MAX_CONSEC_OFF_FAILURECONSTRAINT_MIN_CONSEC_OFF_FAILURECONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR_SHIFT__PER_SHIFTCONSTRAINT_CANNOT_HAVE_DAY_WEEK_MONTH_YEAR__PER_MINUTES_HOURSCONSTRAINT_CONSECUTIVE_SHIFTS_RULE_NOT_ALLOWEDCONSTRAINT_WITH_LARGER_PERIOD_PER_SMALL_PERIOD_NOT_ALLOWEDCONSTRAINT_MIN_MAX_OFF_TIME_FOR_SHIFTS_NOT_ALLOWEDCONSTRAINT_CANNOT_HAVE_CONSECUTIVE_TIME_PER_MULTIPLE_SHIFTSCANNOT_GENERATE_TOUR_PATTERNS_FOR_NON_TOUR_SHIFT_TEMPLATETOUR_PATTERNS_NEEDED_TO_SCHEDULE_TOURSHIFT_TEMPLATE_ACTIVITY_PLACEMENT_MIN_MAX_MUST_BE_MULTIPLE_OF_5_MINUTESNO_SHIFT_TEMPLATE_ACTIVITY_PLACEMENT_SEQUENCES_MATCH_SHIFT_MIN_MAX_WIDTHINVALID_TOUR_PATTERNINVALID_TOUR_AGENT_COLLECTIONINVALID_TOUR_SHIFT_INSTANCE_CONFIGINVALID_TOUR_SHIFT_SEGMENT_CONFIGTOUR_SHIFT_SEGMENT_CONFIG_OVERLAPTOUR_SHIFT_SEGMENT_CONFIG_DOES_NOT_FITTOUR_SHIFT_INSTANCE_CONFIG_OVERLAPWEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_WEEK_PATTERNSWFM_AGENT_SIDS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIST_WEEK_PATTERN_NUMBERS_NOT_UNIQUE_IN_TOUR_AGENT_COLLECTIONSFIRST_WEEK_PATTERN_NUMBERS_NOT_FOUND_IN_TOUR_WEEK_PATTERNSSHIFT_TEMPLATE_HAS_NO_ASSOCIATED_SCHEDULING_AGENT_GROUPSATTEMPT_TO_BUILD_SCHEDULES_FOR_INVALID_PARENT_NODESCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MINIMUMSCHEDULABLE_AGENTS_DO_NOT_MEET_TEMPLATE_MAXIMUMNO_OPEN_TIMES_SET_OR_INHERITED_BY_PROGRAMTOUR_AGENT_COLLECTIONS_NEEDED_TO_SCHEDULE_TOURNO_PREDICTED_CALLS_IN_SCHEDULING_RANGESHIFT_TEMPLATE_MIN_WIDTH_DOW_MISMATCH

source_entity

object (ParentEntity)

source_entity

optional

The entity that the diagnostic was built in reference to.

message

string

message

optional

The message detailing the diagnostic.

Example

{
  "shift_instance": {
    "start_datetime": "1s",
    "schedule_type": "DRAFT",
    "shift_template": {
      "datetime_set_to_inactive": "1s",
      "name": "string",
      "description": "string",
      "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,
      "member_placement_rules": [
        {
          "member_scheduling_activity": {
            "activity_sid": "string",
            "member_non_skill_activity": {
              "datetime_set_to_inactive": "1s",
              "inherited_from_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "name": "string",
              "description": "string",
              "red": 0,
              "green": 0,
              "blue": 0,
              "transparency": 0,
              "non_skill_activity_sid": 0
            },
            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
            "is_skill_activity": true,
            "reason_codes": [
              {
                "datetime_set_to_inactive": "1s",
                "name": "string",
                "is_planned": true,
                "is_paid": true,
                "is_default": true,
                "reason_code_id": 0,
                "scheduling_activity_sid": 0
              }
            ],
            "scheduling_activity_sid": 0,
            "pause_codes": [
              "string"
            ]
          },
          "activity_order": 0,
          "min_duration_minutes": 0,
          "max_duration_minutes": 0,
          "placement_rule_sid": 0,
          "shift_template_sid": 0,
          "scheduling_activity_sid": 0,
          "schedule_scenario_sid": 0
        }
      ],
      "DOW_placements": [
        {
          "placement_type": "MUST_NOT",
          "day_of_week": "MON",
          "start_minute": 0,
          "end_minute": 0,
          "week_number": 0
        }
      ],
      "member_agent_groups": [
        {
          "parent_entity": {
            "parent_type": "CALL_CENTER_NODE",
            "parent_sid": 0
          },
          "datetime_set_to_inactive": "1s",
          "name": "string",
          "description": "string",
          "member_constraint_rules": [
            {
              "scheduling_activity": {
                "activity_sid": "string",
                "member_non_skill_activity": {
                  "datetime_set_to_inactive": "1s",
                  "inherited_from_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "name": "string",
                  "description": "string",
                  "red": 0,
                  "green": 0,
                  "blue": 0,
                  "transparency": 0,
                  "non_skill_activity_sid": 0
                },
                "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                "is_skill_activity": true,
                "reason_codes": [
                  {
                    "datetime_set_to_inactive": "1s",
                    "name": "string",
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "reason_code_id": 0,
                    "scheduling_activity_sid": 0
                  }
                ],
                "scheduling_activity_sid": 0,
                "pause_codes": [
                  "string"
                ]
              }
            }
          ],
          "member_wfm_agents": [
            {
              "tcn_agent_sid": "string",
              "datetime_set_to_inactive": "1s",
              "created_at": "1s",
              "name": "string",
              "member_constraint_rules": [
                {
                  "scheduling_activity": {
                    "activity_sid": "string",
                    "member_non_skill_activity": {
                      "datetime_set_to_inactive": "1s",
                      "inherited_from_entity": {
                        "parent_type": "CALL_CENTER_NODE",
                        "parent_sid": 0
                      },
                      "name": "string",
                      "description": "string",
                      "red": 0,
                      "green": 0,
                      "blue": 0,
                      "transparency": 0,
                      "non_skill_activity_sid": 0
                    },
                    "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
                    "is_skill_activity": true,
                    "reason_codes": [
                      {
                        "datetime_set_to_inactive": "1s",
                        "name": "string",
                        "is_planned": true,
                        "is_paid": true,
                        "is_default": true,
                        "reason_code_id": 0,
                        "scheduling_activity_sid": 0
                      }
                    ],
                    "scheduling_activity_sid": 0,
                    "pause_codes": [
                      "string"
                    ]
                  }
                }
              ],
              "member_skill_proficiencies": [
                {
                  "preferred_skill_profile_sid": "string",
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "manual_proficiency_value": 0,
                  "skill_name": "string",
                  "skill_profile_name": "string",
                  "skill_profile_proficiency_value": 0,
                  "skill_proficiency_sid": 0,
                  "skill_sid": 0
                }
              ],
              "member_agent_availability_patterns": [
                {
                  "parent_entity": {
                    "parent_type": "CALL_CENTER_NODE",
                    "parent_sid": 0
                  },
                  "datetime_pattern": {
                    "week_maps": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "day_maps": [
                          {
                            "day_of_week": "MON",
                            "value": {},
                            "start_minute_in_day": 0,
                            "end_minute_in_day": 0
                          }
                        ]
                      }
                    ],
                    "calendar_items": [
                      {
                        "datetime_range": {
                          "start_datetime": "1s",
                          "end_datetime": "1s"
                        },
                        "value": {
                          "availability_option": "AVAILABLE"
                        }
                      }
                    ]
                  },
                  "scheduling_activity_sid": "string",
                  "agent_availability_pattern_sid": 0,
                  "schedule_scenario_sid": 0
                }
              ],
              "tcn_agent_is_enabled": true,
              "wfm_agent_sid": 0
            }
          ],
          "member_skill_proficiencies": [
            {
              "preferred_skill_profile_sid": "string",
              "parent_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "manual_proficiency_value": 0,
              "skill_name": "string",
              "skill_profile_name": "string",
              "skill_profile_proficiency_value": 0,
              "skill_proficiency_sid": 0,
              "skill_sid": 0
            }
          ],
          "member_agent_availability_patterns": [
            {
              "parent_entity": {
                "parent_type": "CALL_CENTER_NODE",
                "parent_sid": 0
              },
              "datetime_pattern": {
                "week_maps": [
                  {
                    "datetime_range": {
                      "start_datetime": "1s",
                      "end_datetime": "1s"
                    },
                    "day_maps": [
                      {
                        "day_of_week": "MON",
                        "value": {
                          "availability_option": "AVAILABLE"
                        },
                        "start_minute_in_day": 0,
                        "end_minute_in_day": 0
                      }
                    ]
                  }
                ],
                "calendar_items": [
                  {
                    "datetime_range": {
                      "start_datetime": "1s",
                      "end_datetime": "1s"
                    },
                    "value": {
                      "availability_option": "AVAILABLE"
                    }
                  }
                ]
              },
              "scheduling_activity_sid": "string",
              "agent_availability_pattern_sid": 0,
              "schedule_scenario_sid": 0
            }
          ],
          "agent_group_sid": 0,
          "schedule_scenario_sid": 0
        }
      ],
      "shift_template_sid": 0,
      "program_node_sid": 0,
      "schedule_scenario_sid": 0
    },
    "is_locked": true,
    "width_in_minutes": 0,
    "shift_segments": [
      {
        "scheduling_activity": {
          "activity_sid": "string",
          "member_non_skill_activity": {
            "datetime_set_to_inactive": "1s",
            "inherited_from_entity": {
              "parent_type": "CALL_CENTER_NODE",
              "parent_sid": 0
            },
            "name": "string",
            "description": "string",
            "red": 0,
            "green": 0,
            "blue": 0,
            "transparency": 0,
            "non_skill_activity_sid": 0
          },
          "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
          "is_skill_activity": true,
          "reason_codes": [
            {
              "datetime_set_to_inactive": "1s",
              "name": "string",
              "is_planned": true,
              "is_paid": true,
              "is_default": true,
              "reason_code_id": 0,
              "scheduling_activity_sid": 0
            }
          ],
          "scheduling_activity_sid": 0,
          "pause_codes": [
            "string"
          ]
        },
        "order_in_shift_instance": 0,
        "width_in_minutes": 0,
        "start_minute_in_shift": 0,
        "call_stats_by_skill_collection": [
          {
            "skill_collection": {
              "skill_profile_category_type": "SINGLE_SKILL_PROFILE",
              "skill_profile_category_sid": 0
            },
            "num_calls": 0,
            "percent_fit": 0
          }
        ],
        "shift_segment_sid": 0,
        "shift_instance_sid": 0,
        "scheduling_activity_sid": 0,
        "reason_code_id": 0
      }
    ],
    "planned_shrinkage_percent": 0,
    "shift_instance_sid": 0,
    "shift_template_sid": 0,
    "originating_program_node_sid": 0,
    "schedule_sid": 0,
    "wfm_agent_sid": 0
  },
  "diagnostics": [
    {
      "level": "INFORMATION",
      "code": "GENERAL",
      "source_entity": {
        "parent_type": "CALL_CENTER_NODE",
        "parent_sid": 0
      },
      "message": "string"
    }
  ]
}

🔴500Server Error