Create a time off enrollment

Puts a time off balance on a policy from effective_start to effective_end. A balance can have only one enrollment covering any date. To change a balance's policy, set effective_end on the current enrollment, then create a new one. If effective_start is today or earlier, any annual grant or expiration that's due is written right away.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Sandbox beta only

The Time Off API is in beta and is only available in Sandbox. For more details, see Working with Time Off Policies.

Body Params
string
required

ID of the balance the policy applies to.

string
required

ID of the policy that governs the balance.

date
required

The first date the policy applies to the balance. Can't be changed after the enrollment is created.

date | null

The last date the policy applies to the balance. null for an open-ended enrollment.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json