Update Real Time Payroll enrollment

Use this endpoint to manage a worker's enrollment in Real Time Payroll. All changes to enrollment take effect on the next pay period boundary.

For example, if a worker is currently on weekly payroll and you call this endpoint with enrolled: true, they'll receive a regular weekly payroll payment for the current week, but starting on the first day of the next pay period, they will be enrolled in Real Time Payroll.

If a worker is currently enrolled in Real Time Payroll and you call this endpoint with enrolled: false, they will continue to receive Real Time Payroll payments until the end of the current pay period. Starting on the first day of the next pay period, their earnings will accrue for payment with regularly-scheduled payroll rather than via Real Time Payroll.

Body Params
string
required

Canonical ID of the worker. An external worker ID if one has been set, or an Everee worker ID if not.

boolean
required

Whether to enroll or dis-enroll the worker in Real Time Payroll.

Response

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