Creating and Updating Modules via API

Create and update standalone modules over the API. Only module types that can exist standalone are supported, including SCORM and AICC. Questions this answers: Can I create a video module in a course through the API? What must ContentURL point to when uploading a module via API?

Sep 26, 2026
Knowledge

Title

Article Number

000004407

URL Name

creating-and-updating-modules-via-api

Creating standalone Modules Via API

This functionality is only available for modules that can be created as standalone modules in Litmos including:

SCORM [9]
AICC [17]
Video [4]
Audio [8]
Presentation (.ppt, .pptx, .doc, .docx, .pdf) [5]
Page of Information [11]
Embed [6]
Link [10]
LTI [24]
Assessment [3]
Survey [7]
E signature [21]

NOTE:

Module type value is shown beside each module type.

Modules that cannot be created or updated via API are:

CAT
ILT
User Checklist
Learner Upload
BeaconLive
Box
DropBox
Video Assessment

The <ContentURL>string[max length 1000]</ContentURL> field contains a URL that would initiate a file download in the client browser.

NOTE: The <ContentURL> field described above applies only to POST and PUT requests when uploading or updating modules. (The GET method for retrieving module details does not return or expose the actual content URL). It must point to a valid, downloadable file link to be accepted and is required for the following module types:

FILE-UPLOAD TYPES - ContentURL REQUIRED (must be a downloadable file URL)

SCORM [9]
AICC [17]
Video [4]
Audio [8]
Presentation (.ppt, .pptx, .doc, .docx, .pdf) [5]
Page of Information [11]

URL-BASED TYPES - ContentURL REQUIRED (stored as the content URL, not downloaded)

Embed [6]
Link [10]
LTI [24]

Content URL is not required for these module types:

Assessment [3]
Survey [7]
E signature [21]

The <Status></Status> field represents the file's status and can possess the following values to represent the status

Queued
Uploading
ReadyToProcess
Processing
Ready/Failed

NOTE:

DurationMinutes must be in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Request URI

POST /modules?

Request Body (XML)

<Module>
    <Name>string [max length 100]</Name>
    <Description>string [optional, max length 2000]</Description>
    <ModuleType>9</ModuleType>
    <Active>true/false</Active>
    <Code>string [optional, max length 50]</Code>
    <HideDescription>true/false</HideDescription>
    <NewWindow>true/false</NewWindow>
    <ReviewMode>true/false</ReviewMode>
    <ContentURL>string [max length 1000]</ContentURL>
    <DurationMinutes>integer [optional]</DurationMinutes>
</Module>

Response Body (XML)

<Module xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Id>F6oAfh3hxl81</Id>
    <ModuleType>9</ModuleType>
    <Name>Example SCORM/TC File</Name>
    <Description>Example SCORM/TC File Course Description</Description>
    <Active>true</Active>
    <ModuleRefCode></ModuleRefCode>
    <HideDescription>false</HideDescription>
    <NewWindow>true</NewWindow>
    <ReviewMode>true</ReviewMode>
    <Status>Uploading</Status>
    <DurationMinutes>30</DurationMinutes>
</Module>

Request Body (JSON)

{
  "Name": "string [max length 100]",
  "Description": "string [optional, max length 2000]",
  "ModuleType": 9,
  "Active": true,
  "Code": "string [optional, max length 50]",
  "HideDescription": false,
  "NewWindow": false,
  "ReviewMode": false,
  "ContentURL": "string [max length 1000]",
  "DurationMinutes": 30
}

Response Body (JSON)

{
  "Id": "F6oAfh3hxl81",
  "ModuleType": 9,
  "Name": "Example SCORM/TC File",
  "Description": "Example SCORM/TC File Course Description",
  "Active": true,
  "ModuleRefCode": "",
  "HideDescription": false,
  "NewWindow": true,
  "ReviewMode": true,
  "Status": "Uploading",
  "DurationMinutes": 30
}

Update Modules

This functionality is only available for modules that can be created as standalone modules in Litmos including:

SCORM [9]
AICC [17]
Video [4]
Audio [8]
Presentation (.ppt, .pptx, .doc, .docx, .pdf) [5]
Page of Information [11]
Embed [6]
Link [10]
LTI [24]
Assessment [3]
Survey [7]
E signature [21]

NOTE:

Module type value is shown beside each module type.
DurationMinutes has to be shown in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Request URI

PUT /modules/{moduleid}?

Request Body (XML)

<Module>
    <Id>string [max length 50]</Id>
    <ModuleType>9</ModuleType>
    <Name>string [max length 100]</Name>
    <Description>string [optional, max length 2000]</Description>
    <Active>true/false</Active>
    <Code>string [optional, max length 50]</Code>
    <HideDescription>true/false</HideDescription>
    <NewWindow>true/false</NewWindow>
    <ReviewMode>true/false</ReviewMode>
    <ContentURL>string [max length 1000]</ContentURL>
    <DurationMinutes>integer [optional]</DurationMinutes>
</Module>

Response Body (XML)

<Module xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Id>F6oAfh3hxl81</Id>
    <ModuleType>9</ModuleType>
    <Name>Example SCORM/TC File Updated</Name>
    <Description>Example SCORM/TC File Course Description Updated</Description>
    <Active>true</Active>
    <ModuleRefCode></ModuleRefCode>
    <HideDescription>false</HideDescription>
    <NewWindow>true</NewWindow>
    <ReviewMode>true</ReviewMode>
    <Status>Uploading</Status>
    <DurationMinutes>45</DurationMinutes>
</Module>

Request Body (JSON)

{
  "Id": "F6oAfh3hxl81",
  "ModuleType": 9,
  "Name": "string [max length 100]",
  "Description": "string [optional, max length 2000]",
  "Active": true,
  "Code": "",
  "HideDescription": false,
  "NewWindow": true,
  "ReviewMode": true,
  "ContentURL": "string [max length 1000]",
  "DurationMinutes": 45
}

Response Body (JSON)

{
  "Id": "F6oAfh3hxl81",
  "ModuleType": 9,
  "Name": "Example SCORM/TC File Updated",
  "Description": "Example SCORM/TC File Course Description Updated",
  "Active": true,
  "ModuleRefCode": "",
  "HideDescription": false,
  "NewWindow": true,
  "ReviewMode": true,
  "Status": "Uploading",
  "DurationMinutes": 45
}

Retrieve Modules

Request URI

GET /modules/{moduleid}?

Response Body (XML)

<Module xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Id>Y5z6QDLHG3A1</Id>
    <ModuleType>9</ModuleType>
    <Name>New API TEST FOR SCORM UPDATE</Name>
    <Description>New API TEST FOR SCORM UPDATE</Description>
    <DurationMinutes>integer</DurationMinutes>
    <Active>true</Active>
    <ModuleRefCode/>
    <HideDescription>false</HideDescription>
    <NewWindow>false</NewWindow>
    <ReviewMode>true</ReviewMode>
    <Status>Ready</Status>
</Module>

NOTE:

DurationMinutes is shown in minutes. For example: 1 hour and 30 minutes will be shown as 90 minutes.

Response Body (JSON)

{
  "Id": "Y5z6QDLHG3A1",
  "ModuleType": 9,
  "Name": "New API TEST FOR SCORM UPDATE",
  "Description": "New API TEST FOR SCORM UPDATE",
  "Active": true,
  "Code": "",
  "HideDescription": false,
  "NewWindow": false,
  "ReviewMode": true,
  "Status": "Ready"
}

Delete a Module

Delete a module record.

Request URI

DELETE /modules/{moduleid}?

Response Header

200 OK

Add a AICC/SCORM/Tin Can Module to a Course

A Module can be copied, linked or mirrored into a Course. It is important to understand the difference of each before adding the Module into the Course as it will have implications for Module content management and reporting.

Request URIs

POST /courses/{courseid}/modules/copy?

POST /courses/{courseid}/modules/link?

POST /courses/{courseid}/modules/mirror?

Request Body (XML)

<Modules>
    <Module>
        <Id>string [max length 50]</Id>
    </Module>
</Modules>

Request Body (JSON)

[
{
 "Id": ""
}
]

Response Header

200 OK

Remove a AICC/SCORM/Tin Can Module From a Course

Request URIs

DELETE /courses/{courseid}/modules/{moduleid}

Response Header

200 OK

Resolution

Owner

Jason van Ravenswaay

Validation Status

Not Validated

Publication Status

Published

Article Total View Count

Created By

Jason van Ravenswaay, 10/8/2026, 5:35 AM

Assigned By

Created Date

10/8/2026, 5:35 AM

Assigned To

First Published Date

9/26/2026, 6:02 AM

Last Published Date

9/26/2026, 6:02 AM

Last Modified By

Jason van Ravenswaay, 10/8/2026, 5:35 AM

Last Modified Date

10/8/2026, 5:35 AM

Archived Date