ClearSchedule

Clears shift instances from the @schedule_selector for the org sending the request.
If @node_selector is set, only shifts related to the given @node_selector will be cleared.
If @node_selector is not set, all shifts on the @schedule_selector may be cleared, regardless of the shift template they are associated with.
If @datetime_range is set, only the shifts overlapping the @datetime_range will be cleared.
If @datetime_range is not set, all shifts on the schedule will be considered in range to be deleted and @invert_datetime_range and @start_datetimes_only must be set to false.
If @invert_datetime_range is set to true, the shifts overlapping the range before and after the provided @datetime_range will be deleted.
If @invert_datetime_range is set to false, the provided @datetime_range will be used.
If @start_datetimes_only is set to true, deletes the shifts that start within the @datetime range, or start before or after @datetime_range if @invert_datetime_range is true.
If @start_datetimes_only is set to false, deletes the shifts that overlap with the @datetime range, or overlap the range before or after @datetime_range if @invert_datetime_range is true.
If @delete_locked is set to true, both locked and unlocked shifts will be cleared.
If @delete_locked is set to false, only shifts with @is_locked set to false may be cleared.
Errors:

grpc.Invalid: the @node_selector, @schedule_selector, or @datetime_range in the request are invalid.

grpc.NotFound: the draft schedule with the given @schedule_selector doesn't exist.

grpc.Internal: error occurs when removing the shifts from the schedule.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request

Request Code Samples

Responses