Unenroll workers from a leave policy

Unenroll up to 200 workers from a leave policy, by enrollmentId. An active enrollment ends today, and an upcoming one is cancelled. Enrollments that have already ended can't be unenrolled. The request succeeds or fails as a whole: if any ID isn't found in this policy or has already ended, nothing changes and the 400 lists every one. Get enrollment IDs from List a leave policy's enrollments. See the Guide to the Leave Accrual API.

Path Params
string
required

The leave policy's id.

Body Params
enrollmentIds
array of strings
required
length between 1 and 200

Up to 200 enrollmentIds from this policy.

enrollmentIds*
Responses
200

The enrollments were ended or cancelled. There is no body.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json