Skip to content

Create Courses

Endpoint used to create new courses for your institution in Toolzz LMS.

Terminal window
curl --request POST \
--url 'https://kong.api.toolzz.com.br/api/content/course/new_course' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"title": "<string>",
"long_description": "<string>",
"description_visibility": 1,
"type": 2,
"group": "<string>",
"school": "<string>",
"teachers": "<string>"
}'
{
"data": {
"id": 123,
"title": "<string>",
"status": 1
}
}

ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
titlestringCourse title. Maximum of 50 characters.Yes
long_descriptionstringCourse description. Maximum of 7000 characters.Yes
description_visibilityintShow description. 0: Hidden. 1: Visible.Yes
typeint1: Curricular component. 2: Free course.Yes
groupstringArray of groups by name — enter names comma-separated (e.g., “group1,group2”).Yes
schoolstringSubdomains of schools where the course will be available. Comma-separated.Yes
teachersstringID or email of teachers linked to the course. Comma-separated.Yes
subgrouparrayArray of subgroups by name, comma-separated.No
specialtyarrayArray of specialties by name, comma-separated.No
tagarrayTags related to the course, comma-separated.No
difficultystringDifficulty level: low, medium, or hard.No
coverstringImage with a maximum size of 4096KB in jpeg, png, or jpg format. Alternatively, a hosted image link in the same formats. If not provided, the institution logo will be used.No
statusintCourse status. 0: Draft. 1: Published.No
visibilityint0: Public. 1: Private.No
priceintCourse price for sales.No
type_certificationintCertificate type. 1: Participation. 2: Achievement.No
text_max_attemptsintMaximum attempts for course exams. Allowed values: 1, 2, 3, 4, 5, 50, 100, or 200.No
cutout_ratestringMinimum passing grade.No
link_checkoutstringURL for checkout redirect.No
scheduled_startdateCourse start date, must be equal to or after the current date.No
scheduled_enddateCourse end date, must be after the start date.No
hour_lengthintCourse duration in minutes.No
certificationstringCertificate used in the course. Maximum of 255 characters for name or certificate ID.No
secondary_certificationstringSecondary certificate used in the course. Maximum of 255 characters for name or certificate ID.No
loading_typeintContent loading type. 1: By content. 2: By class.No
co_authorstringCourse co-author. Maximum of 255 characters.No
badgestringBadge. Maximum of 255 characters for name or badge ID.No
class_idsstringClass IDs, comma-separated. E.g., “12345, 16789, 10123”.No
class_typestringType of class to be created. “2”: Filter. “4”: Component.No

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.