Create Training Content [Single]

🚧

Partner Restricted

All LMS API endpoints are restricted to LMS providers that have signed a Paylocity technology partnership agreement.
Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

The Create Training Content [Single] endpoint enables partners to add external media content to a client’s LMS library. This endpoint accepts a POST request to create new content in the customer's LMS library. It is the first step in the two-step process for adding content to the customer's LMS partner content library or on-demand library.

The request includes required content metadata, such as title, description, content URL, and file details. Each content item is assigned a unique external content ID and may include an optional thumbnail URL. The resource schema defines the required and optional properties for content creation.

  • Option 1: Use the payload to add content directly to the customer library.
  • Option 2: Include the training object to add content directly to on-demand trainings.

Ensure that fileDetails.length matches the actual file size. If not, file preview may fail.

Use Cases

  • Partner needs to upload external content metadata (title, description, URL, file details).
  • Partner wants to add content directly to the customer library.
  • Partner wants to add content directly to on-demand trainings.
Path Params
string
required

The Paylocity Company Identifier. Unique value provided by Paylocity.
Allowable Values: 9 char max.

Body Params

The training content payload to be created.

string | null

Title of the media content. Required. Max length 255. Validation: Must not be null or empty, max length 255.

string | null

Description of the media content. Optional. Max length 2000. Validation: If provided, max length 2000.

string
enum

Content type of the media content. Required. Allowed values: File, Url, SCORM, Video. Validation: Must be one of the allowed values.

string | null

If externally hosted, the URL to access the content. Required if ContentType is Url. Max length 2000. Validation: Required if ContentType is Url, must be a valid URL, max length 2000.

fileDetails
object
training
object

Optional training metadata determines content placement. Providing it places the content in the LMS On-Demand Trainings area; omitting it keeps the content in the company content library.

string | null

Optional: Identifies content as part of a specific feature pack

Headers
boolean

If true, responses are mocked and generated randomly.

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json