Switch to dark theme

Switch to light theme

Enable / Disable Employees using API #

Background #

This article will guide you on how to enable/disable a employee using API. Currently, there are two statuses for a employee, "ACTIVE" (Default state for a employee after creation) and "DISABLED".

  • What does disabling a employee means? It means that employee will be logged-out of the current session and an appropriate error message will be provided when they try to login back into the system.

  • When to disable a employee? For eg., when there is no activity from the employee for a period of time or an employee who went on a sabbtical (long-term leave) then, you can go ahead and disable those employee(s).

  • How to enable a employee after disabling? Using the same API, employee could be enabled back again by changing the status to "ACTIVE".

Prerequisites #

Before you get started, there are couple of things that you need:

  • Make sure you have Administrator role (Refer here)
  • Have Auth Token for Authentication (Refer here)



Start Implementing