Custom Field

Use this endpoint to load values to training custom fields at either the Learning Object (LO) level or the Transcript level.

  • A maximum of 50 records can be in each request.
  • Each request can update either the LO level custom field or the Transcript level Custom field, but not both. In other words, updates for the LO level custom fields and the updates for the Transcript level custom fields must be made in separate API calls.
  • Blank values do not overwrite populated values.

Below is a list of custom field types that you can update using this API along with any associated rules:

Custom Field TypeField Requirements
CheckboxTo check, value must be “true” (without doublequotes) value.To uncheck, value must be "false" (without doublequotes).
Date FieldValue must be in the following format: MM-DDYYYY.
DropdownValue must match one of the field’s dropdownvalues
Numeric FieldValue must be a numeric value. Decimals areacceptable.
Radio ButtonValue must match one of the field’s radio buttonvalues.
Scrolling Text BoxValue can be a maximum of 2,000 characters.
Short Text BoxValue can be a maximum of 100 characters.

Permission Required: Training Custom Fields

OAuth 2.0 Scope: training:create

Error Descriptions

Handled Error List

Error TypesError Message
EmailTagEmail tag is missing
ItemTypeInvalid item type
Object IDObject ID missing