Skip to content

Delete a time off policy

Crew module

DELETE/time-off-policies/{id}timeOffPolicies.delete

A time off policy. Soft-deletes the time off policy: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.payroll.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

timeOffPolicies.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the time off policy.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/time-off-policies/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.timeOffPolicies.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.time_off_policies.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos time-off-policies delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f