v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Training

Public API

Create Training Type

Creates a new training type. Only 'name' is required; all other fields are optional. When 'renewable' is true, 'frequency' (months between renewals) must also be provided. The 'dueFromHireDate' field is only valid when 'required' is true. The authenticated caller must have access to training settings.

OAuth Scopes: training.write

post/api/v1/training/type

Request body

namestring required

Name of the new 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 which is the months between renewals.

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 New Training",
  "frequency": "12",
  "renewable": "1",
  "category": {
    "id": "3",
    "name": "CustomApiCategoryName2"
  },
  "required": "",
  "dueFromHireDate": {
    "unit": "day",
    "amount": "30"
  }
}

Response

Created

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.