Enroll workers in a leave policy

Enroll up to 200 workers in a leave policy. Each worker's enrollment starts tomorrow, and any enrollment they have in another policy ends today, so their leave carries on without a gap. The response has one enrollment in this policy for each worker.

Workers who are already active in this policy aren't changed, other than a pending move to a different policy being cancelled. The request succeeds or fails as a whole: if any worker isn't found, is a contractor, or has an employment end date of today or earlier, nothing changes and the 400 lists every worker that's a problem. See the Guide to the Leave Accrual API.

Path Params
string
required

The leave policy's id.

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

Up to 200 workers, by externalWorkerId or Everee workerId.

workerIds*
Responses

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