v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Scheduling
Public API

Delete Shift

Deletes a shift by its UUID or composite recurrence ID. Use recurrenceEditOption to control the scope to delete one or many consecutive recurring shifts

OAuth Scopes: scheduling:shifts.write, time_tracking.write

delete/api/v1/scheduling/shifts/{id}

Path parameters

idstring uuid required

The shift UUID, or the projected shift composite ID.

Query parameters

recurrenceEditOption'instance' | 'future' | 'all'
Example:future

How should the shift be deleted? Choose 'instance' for deleting a single target shift, 'future' for deleting the target shift and all following shifts that are in the same recurrence, 'all' for deleting all shifts starting from now that are in the same recurrence as the target shift.

Response

Shift deleted successfully. No content returned.