v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Incentives Kpi

Partial Update

Update a subset of properties of an incentive-kpi

patch/public/api/incentives-kpi/{id}

Path parameters

idstring required

The id of the incentive-kpi

idstring required

The id of the incentive-kpi

Headers

Acceptstring

e.g. application/json

Request body

totalnumber

countnumber

Example request

{
  "total": 10,
  "count": 5
}

Response

incentive_kpi_idstring

incentive_idstring

owner_idstring

first_namestring

last_namestring

usernamestring

participant_idstring

start_timestring

end_timestring

totalnumber

countnumber

weightnumber

participant_typestring

created_datestring

updated_datestring

Example response

{
  "incentive_kpi_id": "5eb8fd0a7d5ff5748adcb039",
  "incentive_id": "5eb8fd017d5ff5748adcaf09",
  "owner_id": "5eb8fd017d5ff5748adcaef5",
  "first_name": "my",
  "last_name": "company",
  "username": "mcompany@mycompany.com",
  "participant_id": "5eb8fd017d5ff5748adcaef5",
  "start_time": "2020-01-01T00:00:00.000Z",
  "end_time": "2020-01-31T23:59:59.999Z",
  "total": 10,
  "count": 5,
  "weight": 2,
  "participant_type": "individual",
  "created_date": "2020-01-01T00:00:00.000Z",
  "updated_date": "2020-01-01T00:35:00.000Z"
}