PUT /api/v1/paths/{path_id}
Update a path within the platform.
Body
The following properties must be provided in the Body, formatted as raw/JSON.
| Name | Values | Description |
|---|---|---|
name | string | Name of the path. Cannot be null or empty |
description | string | Description of the path. Can be null or empty |
authorMails | string | List of authors: main author (first one), co-authors (the rest) for this path, provided by their emails inside an array, it can be null or empty |
ownerGroup | ObjectId as string | Id of the group owning the path. Cannot be null or empty |
skills | Array as string | Id of the skills. Can be null or empty |
additionalInformation | string | Path additional information. Can be null or empty |
certificate | string | Id of the certificate. Can be null or empty |
mandatoryReplay | boolean | Cannot be null or empty |
sendAutomatedReminders | boolean | Cannot be null or empty |
linear | boolean | Cannot be null or empty |
disableForum | boolean | Can be null or empty |
duration | number as string | Can be null or empty |
estimatedWeeklyCommitment | range as string | Can be null or empty |
uploadedImage | ObjectId as string | Can be null or empty |
sourceLang | string | Cannot be null or empty |
defaultLang | string | Cannot be null or empty |
Responses
Success
{
"status": "path_updated",
"_id": "59f1fd5cb91bedcf09c77063"
"_id": "59f1fd5cb91bedcf09c77063"
}
Errors
| Status code | Error body | Reason |
|---|---|---|
404 | { "error": "group_not_found" } | if the group Id doesn't belong to the company or is not valid |
400 | { "error": "invalid_path_name" } | if the provided path name is null or empty |
400 | { "error": "invalid_path_owner_group" } | if the provided path owner group doesn't belong to the company or is not valid |
400 | { "error": "invalid_authors" } | if the provided authorsMails is null or empty or is not valid |
400 | { "error": "invalid_skills" } | if the provided skills ID is not valid |
400 | { "error": "invalid_steps" } | if the provided steps ID is not valid or nul or empty |
400 | { "error": "invalid_certificate" } | if the provided certificate ID is not valid |
400 | { "error": "invalid_start_date" } | if the provided start date is not valid, or null or empty |
400 | { "error": "invalid_end_date" } | if the provided end date is not valid |
400 | { "error": "invalid_instructors" } | if the provided instructorsMails is null or empty or is not valid |
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
path_id |
String | Yes |
ID of the path |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sourceLang |
String | No | |
name |
String | No | |
sendAutomatedReminders |
Boolean | No | |
defaultLang |
String | No | |
description |
String | No | |
ownerGroup |
String | No | |
linear |
Boolean | No | |
authorMails[] |
Array | No | |
mandatoryReplay |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.