Edit Courses

Endpoint used to edit courses in your institution in Toolzz LMS.

Request Example

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

Response Example

{
  "data": {
    "id": 123,
    "title": "<string>",
    "status": 1
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
id	int	ID of the course to be edited.	Yes

Body Parameters

Parameter	Type	Description	Required
title	string	Course title. Maximum of 50 characters.	Yes
long_description	string	Course description. Maximum of 7000 characters.	Yes
description_visibility	int	Show description. 0: Hidden description. 1: Visible description.	Yes
type	int	1: Curricular component. 2: Free course.	Yes
school	string	Subdomains of schools where the course will be available. Array with comma-separated values.	Yes
teachers	string	ID or email of teachers linked to the course. Array with comma-separated values.	Yes
groups	number[]	Array for groups by names, comma-separated.	Yes
subgroup	number[]	Array for subgroups by names, comma-separated.	No
specialty	number[]	Array for specialties by names, comma-separated.	No
tag	array	Tags related to the course, comma-separated.	No
difficulty	string	Difficulty level: low, medium, or hard.	No
cover	string	Image 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
status	int	Course status. 0: Draft. 1: Published.	No
visibility	int	0: Public. 1: Private.	No
price	int	Course price for sales.	No
type_certification	int	Certificate type. 1: Participation. 2: Achievement.	No
text_max_attempts	int	Maximum attempts for course exams. Allowed values: 1, 2, 3, 4, 5, 50, 100, or 200.	No
cutout_rate	string	Minimum passing grade.	No
link_checkout	string	URL for checkout redirect.	No
scheduled_start	date	Course start date, must be equal to or after the current date.	No
scheduled_end	date	Course end date, must be after the start date.	No
hour_length	int	Course duration in minutes.	No
certification	string	Certificate used in the course. Maximum of 255 characters for name or certificate ID.	No
secondary_certification	string	Secondary certificate used in the course. Maximum of 255 characters for name or certificate ID.	No
loading_type	int	Content loading type. 1: By content. 2: By class.	No
co_author	string	Course co-author. Maximum of 255 characters.	No
badge	string	Badge. Maximum of 255 characters for name or badge ID.	No
clean_tags	int	1: Clear all TAGs.	No
clean_filters	int	1: Clear filters.	No
clean_schools	int	1: Clear schools.	No

---

Security

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.