Update KPI details

Update details of an existing KPI.

This is the endpoint suitable for updating an already created KPI. The following parameters are dependent on what has been configured in settings;

Parameters

  • perspective: This field has to be a valid perspective on your HRMS application. This must have been created in the perspective tab under KPI settings. See (settings tab > BSC > perspective)
  • kpi_type: This is a required field and accepts a string. It can be one of the following options based on the number of KPI types selected in the settings: Type 1, Type 2, Type 3, Type 4, Type 5, Type 6, Type 7, Type 8
  • threshold: This field is only required when the kpi_type is either Type 6 or Type 7.
  • target: This field is only required when the kpi_type is not Type 8
  • frequency: This is a required field and accepts a string. It can be one of the following options: monthly, weekly, entire cycle.
Body Params
string
required
string
required

employee code

string
required

appraisal cycle title

string
required
string

reviewer employee code

string
required
string
string
int32
required
string
enum
required
int32

required if kpi_type is not Type 8

int32

required for Type 6 and 7 kpi_type

boolean
string
enum
required
Allowed:
Responses

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