Time Off
Public API

Delete Time Off Policy

Changed on

Soft-deletes a time off policy. Every employee currently assigned to the policy is unassigned first and their assignment rows are archived, so a single call replaces what an admin does by hand; there is no conflict response for a policy that still has assignments. Historical balances and time off requests tied to the policy are retained; the policy simply stops appearing in policy lists and can no longer be assigned. The operation is idempotent: an id that has already been deleted, and an id no policy has ever carried, both return 204 rather than 404.

OAuth Scopes: time_off:policies.write

delete/api/v1/time-off/policies/{id}

Request

Path parameters

idinteger required

The time off policy ID.

Response

The policy is deleted. Returned whether this call deleted it, an earlier call already did, or no policy with that id has ever existed. No response body.

Changes