Dismiss employees
Changed onUp to 100 people in one call, each named by external_id or by id, exactly one per item.
This is dismissal, not erasure. The record stays and stays readable: the person appears under status=dismissed with dismissed_at set, and the seat is freed for somebody else. It is the shape leaving actually has — a nightly sync noticing that twelve people are no longer on the roster.
There is no hard delete on this API. Erasing a person takes their attendance, payroll, documents and bank details with them, with no way to undo it, and one ability grants this whole API — an integrator that syncs your roster cannot be given that without also being given erasure. If a retention obligation needs it, ask us.
Somebody already gone answers already_dismissed rather than failing, which matters here because dismissing frees the key for a new hire.
If a key is held by two people — one who left and one hired since — the living one is the one dismissed.
What happens that you cannot see, and cannot undo:
- Their sessions end immediately and their phone is unpaired.
- Every terminal at their locations is told to forget their face. That is sent once and not retried, so a terminal that is offline at the time keeps admitting them.
- Requests still waiting on them to approve are cancelled, not just their own. Dismiss a manager and their team's pending vacation requests are cancelled with them.
- An offboarding process starts, if the company has one configured.
- date_leave is filled in with today's date if it was empty.
Request
- Base URL: https://api.clockster.com
- URL: https://api.clockster.com/company/v3/users/dismiss
- Auth: HTTP bearer
Request body
Response
Success
Changes
- info
the endpoint scheme security
companyTokenwas added to the API
- info
- breaking
removed the required property
//from the response with the status
- breaking