v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Training

Public API

Update Training Type

Updates an existing training type. Only provided fields are updated. To remove a category, pass an empty string or null for the category field. Returns 405 when the training type cannot be modified. The authenticated caller must have access to training settings.

OAuth Scopes: training.write

put/api/v1/training/type/{trainingTypeId}

Path parameters

trainingTypeIdinteger required

The ID of the training type to update.

Request body

namestring

Name of the training type.

frequencyinteger

The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable.

renewableboolean

Renewable is optional but if you are setting it to true you must pass a frequency.

requiredboolean

Is this a required training?

dueFromHireDateinteger

Number of days before the training is due for new hires. Not valid unless training is required.

linkUrlstring

Optional URL that can be included with a training.

descriptionstring

Description for the training.

allowEmployeesToMarkCompleteboolean

Allows all employees who can view the training to be able to mark it complete.

Example request

{
  "name": "My Edited Training",
  "frequency": "12",
  "renewable": "1",
  "category": {
    "name": "Existing or new training category"
  },
  "required": "",
  "dueFromHireDate": {
    "unit": "day",
    "amount": "30"
  }
}

Response

Returns the updated training type.

idinteger

The ID of the training

namestring

Name of the training type.

renewableboolean

If true, training will be renewed based off of frequency.

frequencyinteger

The frequency is the (optional) amount of months between renewing trainings. Not valid if training are not renewable.

dueFromHireDateinteger

Number of days before the training is due for new hires. Not valid if training is not required.

requiredboolean nullable

Whether this is a required training. Null when not set.

linkUrlstring nullable

Optional URL that can be included with a training. Null when not set.

descriptionstring nullable

Description for the training. Null when not set.

allowEmployeesToMarkCompleteboolean

Allows all employees who can view the training to be able to mark it complete.