Create training course
curl --request POST \
--url https://app.msportal.ai/api/public/v1/training/courses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"courseType": "<string>",
"description": "<string>",
"courseCategory": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isMandatory": true,
"passingScore": 50,
"duration": 2,
"maxAttempts": 2,
"expiresAfterDays": 2,
"youtubeUrl": "<string>",
"artworkUrl": "<string>"
}
'import requests
url = "https://app.msportal.ai/api/public/v1/training/courses"
payload = {
"title": "<string>",
"courseType": "<string>",
"description": "<string>",
"courseCategory": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isMandatory": True,
"passingScore": 50,
"duration": 2,
"maxAttempts": 2,
"expiresAfterDays": 2,
"youtubeUrl": "<string>",
"artworkUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
courseType: '<string>',
description: '<string>',
courseCategory: '<string>',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
isMandatory: true,
passingScore: 50,
duration: 2,
maxAttempts: 2,
expiresAfterDays: 2,
youtubeUrl: '<string>',
artworkUrl: '<string>'
})
};
fetch('https://app.msportal.ai/api/public/v1/training/courses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.msportal.ai/api/public/v1/training/courses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'courseType' => '<string>',
'description' => '<string>',
'courseCategory' => '<string>',
'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'isMandatory' => true,
'passingScore' => 50,
'duration' => 2,
'maxAttempts' => 2,
'expiresAfterDays' => 2,
'youtubeUrl' => '<string>',
'artworkUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.msportal.ai/api/public/v1/training/courses"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.msportal.ai/api/public/v1/training/courses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/training/courses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"courseType": "<string>",
"courseCategory": "<string>",
"isMandatory": true,
"passingScore": 123,
"duration": 123,
"maxAttempts": 123,
"expiresAfterDays": 123,
"artworkUrl": "<string>",
"youtubeUrl": "<string>",
"isGlobal": true,
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"enrollmentCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"scormUrl": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Training
Create training course
Create a new training course.
POST
/
api
/
public
/
v1
/
training
/
courses
Create training course
curl --request POST \
--url https://app.msportal.ai/api/public/v1/training/courses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"courseType": "<string>",
"description": "<string>",
"courseCategory": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isMandatory": true,
"passingScore": 50,
"duration": 2,
"maxAttempts": 2,
"expiresAfterDays": 2,
"youtubeUrl": "<string>",
"artworkUrl": "<string>"
}
'import requests
url = "https://app.msportal.ai/api/public/v1/training/courses"
payload = {
"title": "<string>",
"courseType": "<string>",
"description": "<string>",
"courseCategory": "<string>",
"companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isMandatory": True,
"passingScore": 50,
"duration": 2,
"maxAttempts": 2,
"expiresAfterDays": 2,
"youtubeUrl": "<string>",
"artworkUrl": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
courseType: '<string>',
description: '<string>',
courseCategory: '<string>',
companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
isMandatory: true,
passingScore: 50,
duration: 2,
maxAttempts: 2,
expiresAfterDays: 2,
youtubeUrl: '<string>',
artworkUrl: '<string>'
})
};
fetch('https://app.msportal.ai/api/public/v1/training/courses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.msportal.ai/api/public/v1/training/courses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'courseType' => '<string>',
'description' => '<string>',
'courseCategory' => '<string>',
'companyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'isMandatory' => true,
'passingScore' => 50,
'duration' => 2,
'maxAttempts' => 2,
'expiresAfterDays' => 2,
'youtubeUrl' => '<string>',
'artworkUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.msportal.ai/api/public/v1/training/courses"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.msportal.ai/api/public/v1/training/courses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.msportal.ai/api/public/v1/training/courses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"courseType\": \"<string>\",\n \"description\": \"<string>\",\n \"courseCategory\": \"<string>\",\n \"companyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isMandatory\": true,\n \"passingScore\": 50,\n \"duration\": 2,\n \"maxAttempts\": 2,\n \"expiresAfterDays\": 2,\n \"youtubeUrl\": \"<string>\",\n \"artworkUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"courseType": "<string>",
"courseCategory": "<string>",
"isMandatory": true,
"passingScore": 123,
"duration": 123,
"maxAttempts": 123,
"expiresAfterDays": 123,
"artworkUrl": "<string>",
"youtubeUrl": "<string>",
"isGlobal": true,
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"enrollmentCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"scormUrl": "<string>",
"metadata": {}
}
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}{
"error": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"code": "<string>"
}Authorizations
Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.
Body
application/json
Course title (required)
Required string length:
1 - 200Course type (required)
Required string length:
1 - 50Course description
Maximum string length:
5000Course category
Maximum string length:
100Company ID (for company-specific courses)
Whether completion is mandatory
Required passing score
Required range:
0 <= x <= 100Duration in minutes
Required range:
x >= 1Maximum attempts allowed
Required range:
x >= 1Certificate validity in days
Required range:
x >= 1YouTube video URL
Artwork/thumbnail URL
Response
Course created
Show child attributes
Show child attributes
Was this page helpful?
⌘I