Edit Trails

Endpoint used to edit previously created learning trails in your institution in Toolzz LMS.

Request Example

curl --request POST \
  --url 'https://kong.api.toolzz.com.br/api/content/trail/edit_trail/{trail_id}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "trail_title": "<string>",
    "trail_description": "<string>",
    "school": []
  }'

Response Example

{
  "data": {
    "id": 123,
    "trail_title": "<string>",
    "status": "published"
  }
}

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
`trail_id`	string	Identifier of the trail to be edited.	Yes

Body Parameters

Parameter	Type	Description	Required
`trail_title`	string	Trail title. Maximum of 255 characters.	Yes
`trail_description`	string	Trail description.	Yes
`school`	array	Subdomains of schools where the trail will be available. Array with comma-separated values.	Yes
`clean_filters`	string	0 or null: keep registered filters (default). 1: Clear filters.	No
`group`	array	Array with group names, comma-separated.	No
`subgroup`	array	Array with subgroup names, comma-separated.	No
`specialty`	array	Array with specialty names, comma-separated.	No
`trail_start_date`	date	Trail start date. Must be equal to or after the current date.	No
`trail_end_date`	date	Trail end date. Must be after `trail_start_date`.	No
`workload`	int	Workload. Must be greater than 0.	No
`certificate`	string	Certificate awarded in the trail. Maximum of 255 characters for name or certificate ID.	No
`progression_criteria`	int	Progression criteria. 0: No criteria. 1: Sequential. 2: By period. 3: By performance.	No
`volume`	int	Integer representing the volume. Must be between 1 and 10.	No
`tag`	array	Tags, comma-separated.	No
`trail_view`	int	Trail visual. 0: Standard view. 1: Gamified view.	No
`content_action`	int	0: Keep current courses/content and add new ones (default). 1: Remove specified courses/content and add new ones. 2: Clear all specified courses/content.	No
`available_content`	string	Trail content items, comma-separated. Each item must be the name or ID of the content.	No
`available_content_type`	int	Type of content included in `available_content`, comma-separated. 0: Course type. 1: Content type. Positionally associated with each content in `available_content`.	No
`cover`	string	Cover image URL. Must be in ‘jpeg’, ‘png’, or ‘jpg’ format and max 4096 KB. If not provided, the institution logo will be used.	No
`days_to_release`	int	Days to release the next content. Required if `progression_criteria` is 2. Must be greater than 1.	No
`trail_is_exclusive`	boolean	Defines if the trail is exclusive.	No
`class_ids`	array	Class IDs to be linked to the trail. If `trail_is_exclusive` is true and `class_ids` is not provided, classes will be created automatically within the schools specified in `school`.	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.