Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Training
Public API

Update Employee Training Record

Updates an existing employee training record. The 'completed' date (yyyy-mm-dd) is required; all other fields are optional. Returns the updated TrainingRecord with HTTP 201. Returns 405 when the record cannot be updated. The authenticated caller must have permission to edit trainings for the employee.

OAuth Scopes: training.write

put/api/v1/training/record/{employeeTrainingRecordId}

Path parameters

employeeTrainingRecordIdinteger required

The ID of the training record to update.

Request body

completedstring required

Completed is the only required field and must be in yyyy-mm-dd format. The other parameters are optional.

instructorstring

Name of the training instructor.

hoursnumber

Number of hours for the training.

creditsnumber

Credits earned for the training.

notesstring

Optional notes about the training record.

Example request

{
  "completed": "2026-03-12",
  "cost": {
    "currency": "USD",
    "amount": "100.00"
  },
  "instructor": "Bob Jones",
  "hours": "16",
  "credits": "4",
  "notes": "sample note"
}

Response

Updated

idinteger

The ID of the training record.

employeeIdstring

The internal employee ID of the employee associated with the training, returned as a string.

completedstring date

Completed is a date in the format yyyy-mm-dd.

notesstring nullable

Notes left on the training record. Null when not set.

instructorstring nullable

Name of the instructor. Null when not set or when disabled by company training settings.

creditsstring nullable

Credits earned for the training record, returned as a string. Null when not set or when disabled by company training settings.

hoursstring nullable

Hours associated with the training record, returned as a string. Null when not set or when disabled by company training settings.

coststring nullable

The cost in the format '{amount} {currency}', e.g. '50.00 USD'. May be null or empty string when not set.