Update Employee Enrollment

Enables, disables, or reassigns a single employee's enrollment using JSON Merge Patch (RFC 7396) semantics: only the properties present in the body are applied and omitted properties are unchanged. Content-Type must be application/merge-patch+json. When the employee has no enrollment record yet and enabled is set to true, one is created. timezone and clockInId are read-only on this API. Reassigning an employee whose time tracking is currently off requires setting enabled to true in the same body, and configurationId and enabledOn cannot be combined with enabled: false.

OAuth Scopes: time_tracking:employees.write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The employee ID.

Body Params

JSON Merge Patch body for an employee time tracking enrollment. Every property is optional; omitted properties are unchanged.

boolean

True to enable time tracking for the employee, false to disable it. Disabling retains the enrollment record for history.

The configuration to enroll the employee in. Null falls back to the company's GLOBAL configuration. Cannot be sent in the same body that sets enabled to false.

date

Effective date for the enable, in YYYY-MM-DD format. Only honored while enabled is being set to true; defaults to today.

Responses

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