UpdateShiftTemplate

Updates a shift template for the given @shift_template_sid and org sending the request with the provided parameters.
All of the entity's parameters that are not desired to be updated must be filled with their current values.
The @schedule_scenario_sid must be the original for this shift template since it cannot be changed.
The @member fields will be ignored since those cannot be updated by this method and must be updated by their respective update methods.
Errors:

grpc.Invalid: the @shift_template_sid, @name, @program_node_sid are invalid.

grpc.AlreadyExists: a shift template with the given @name already exists.

grpc.NotFound: the parent program node doesn't exist or belongs to a different scenario than the shift template to update.

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

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 UpdateShiftTemplate RPC

shift_template

object (ShiftTemplate)

shift_template

optional

Shift template to update

datetime_set_to_inactive

string <date-time>

datetime_set_to_inactive

optional

Datetime that the template was set to inactive, if not set then the template is currently active.

Examples:

1s1.000340012s

name

string

name

optional

Template name

description

string

description

optional

Template description

is_tourshift

boolean

is_tourshift

optional

Type of Shift Template (true=tour shift, false=dynamic shift)

min_shift_width

integer <int32>

min_shift_width

optional

Min shift width (minutes)

max_shift_width

integer <int32>

max_shift_width

optional

Max shift width (minutes)

min_agents

integer <int32>

min_agents

optional

Min number of agent shifts for shift template

max_agents

integer <int32>

max_agents

optional

Max number of agent shifts for shift template

shift_start_boundary_minutes

integer <int32>

shift_start_boundary_minutes

optional

Intervals upon which shifts may start (minutes)

same_time_each_DOW

boolean

same_time_each_DOW

optional

Whether or not shifts in this shift template must start at the same time each day of the week

same_length_per_agent

boolean

same_length_per_agent

optional

Whether or not all of an Agent's shifts in this shift template will be the same length

member_placement_rules

array[object (PlacementRule) {8}]

member_placement_rules

optional

The placement rules associated with @shift_template_sid.

DOW_placements

array[object (DOWPlacement) {5}]

DOW_placements

optional

The DOW_placements set the placement days for the shift template.
The length of the list must be divisible by seven to represent days of the week.
May include more sets of seven days to represent another sequential week (ie, 21 placements for 3 weeks).
The DOWPlacements represents sequential days of the week, always starting on Sunday.

member_agent_groups

array[object (AgentGroup) {10}]

member_agent_groups

optional

agent groups that are children of call center node

shift_template_sid

integer <int64> | string

shift_template_sid

optional

ID of this shift template.

program_node_sid

integer <int64> | string

program_node_sid

optional

Parent node id -- parent will only be a program nodes

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

ID of the schedule scenario that the shift template belongs to.

Example

{
  "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": {
                            "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
              }
            ],
            "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
  }
}

Request 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/updateshifttemplate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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": {
                                                        "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
                            }
                        ],
                        "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
    }
}'

UpdateShiftTemplate

Request

Request samples

Responses