Example response

{
  "status": "success",
  "data": [
  ],
  "message": "User set inactive."
}

Parameters

An optional inactive parameter can be sent in the payload to describe the sentiment of the departure. This is useful for managers to understand why a user has been set inactive.

Parameter

Type

Required

Description

Example

inactive

Array

No

An array of JSON objects describing the sentiment of the departure.

{
"inactive": {
"reason": "OTHER",
"comments": "No Reason"
}
}

Inactive Reasons

A reason can be set to one of the following values

Reason

VOLUNTARY_RESIGNATION

UNACCEPTABLE_BEHAVIOUR

MEDICAL_PERSONAL_REASONS

GOING_BACK_TO_SCHOOL

FOUND_ANOTHER_JOB

COVID_19_LAYOFFS

COMPANY_SEASONALITY

BUSINESS_CONDITIONS

WENT_BACK_TO_SCHOOL

MATERNITY_LEAVE

THEFT

QUIT

NO_SHOW_LATE

RUDE_TO_CUSTOMERS

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!