Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

Delete a custom shift

<!-- theme: info -->

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Delete a custom shift by ID. When the shift is not started, it deletes the shift entirely. If the shift is already started, it sets the end_time to now. It returns Bad Request when shift is already ended.

delete/v3/schedules/{id}/custom_shifts/{custom_shift_id}

Path parameters

idstring required

The ID of the schedule.

custom_shift_idstring required

The ID of the custom shift.

Response

Custom shift deleted successfully