POST /api/v1/paths/

Create a path within the platform.

Body

The following properties must be provided in the body, formatted as raw/JSON.

Property	Type	Description
`name`	String	Name of the path. Cannot be `null` or empty
`description`	String	Description of the path. Can be `null` or empty
`authorMails`	Array	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
`steps`	Array of step objects	Cannot be null or empty
`steps` / course	Object	Course step object with the following properties: - `"type"`: String (required). Value must be `"course"`. - `"id":` String (required). ID of the course.
`steps` / email	Object	Email step object with the following properties: - `"type"`: String (required). Value must be `"email"`. - `"bodyHtml"`: String (required) - `"title"`: String (required) - `"headlineHtml"`: String (optional) - `"mainCtaText"`: String (optional) - `"scheduling"`: Object (optional) - `"attachmentIds"`: Object (optional) - `"coverMediaId"`: String (optional)
`steps` / email / `scheduling`	Array	Array with the following properties: - `"relativeTo"`: `"enrollmentDate"` or `"sessionStartDate"` (String, required) - `"relativity"`: Number of days (Integer, required) - `"condition"`: `"successful"`, `"not-successful"`, `"completed"` or `"not-completed"` (String, optional)
`steps` / assessment	Object	Assessment step object with the following properties: - `"type"` String (required). Value must be `"assessment"`. - `"groupId"`: String (required). - `"assessmentName"`: String (required) - `"learnersInstructions`: String (optional) - `"assessorType"`: "instructors" or "managers" (String, required) - `"assessorInstructions`: String (optional) - `"scoring"`: Object (required) - `"isExamination"`: boolean (required)
`steps` / assessment / `scoring`	Object	Object with the following properties: - `"scoreMode"`: "yesNo" or "scored" (String, required) - `"minScore"`: integer (required if "scoreMode" is "scored")
`steps` / classroom	Object	Classroom step object with the following properties: - `"type"`: String (required). Value must be `"classroom"`. - `"name"`: String (required). Name of the classroom step. - `"trainingObjective"`: String (optional). Training objective of the classroom step, visible to learners on the path homepage. - `"message"`: String (optional). Message that will be sent to users via email when added to the given classroom slot. This message will be the default message on every slot created on the step. - `"medias"`: ObjectId (optional). ID of an object attached to the classroom step. - `"options"`: Object (optional) described below.
`steps` / classroom / `options`	Object	Object (optional) with the options of the classroom step, with the following properties: - `"isAutoRegistrationEnabled"`: Boolean (optional). `true` if learners are automatically enrolled in the first available classroom slot, `false` otherwise. Set to TRUE by default. - `"selfRegistration"`: Object (optional) to enable learners to select their classroom slots freely or switch between classroom slots. Includes `"enabled"` and `"delay"`, described below. - `"attendanceSheets"`: Object (optional) to set the number of attendance sheets that will be automatically created per day each time a slot is added to this classroom step. The sheets for each day will be appended with the date that they are created for. Includes `"number"` and `"value"` (described below). Note: When `"option"` is not included, the classroom step is created with both automatic registration and self registration enabled.
`steps` / classroom / `options` / `selfRegistration` / `enabled`	Boolean	`true` if self registration is enabled, `false` otherwise.
`steps` / classroom / `options` / `selfRegistration` / `delay`	Object	Object to specify the cutoff time for when a learner can self-register to a classroom slot. Includes the following properties: - `"unit"`: String, either `"day"`, `"week"`, or `"month"`. - `"value"`: Integer specifying the cut-off time. For example: `"selfRegistration":{enabled:true,delay:{unit:"day",value:5}}` means that learners can enroll up to 5 days before the classroom starts.
`steps` / classroom / `options` / `attendanceSheets` / `number`	Integer	Number of attendance sheets created per day each time a slot is added to the classroom step.
`steps` / classroom / `options` / `attendanceSheets` / `unit`	String	Either `"day"`, `"week"`, or `"month"`.
`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_created",
  "_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

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
`sourceLang`	String	No
`name`	String	No
`sendAutomatedReminders`	Boolean	No
`defaultLang`	String	No
`description`	String	No
`ownerGroup`	String	No
`steps[]`	Array	No
`steps[].mainCtaText`	String	No
`steps[].assessorType`	String	No
`steps[].learnersInstructions`	String	No
`steps[].attachmentIds[]`	Array	No
`steps[].scheduling`	Object	No
`steps[].scheduling.condition`	String	No
`steps[].scheduling.relativity`	Number	No
`steps[].scheduling.relativeTo`	String	No
`steps[].isExamination`	Boolean	No
`steps[].scoring`	Object	No
`steps[].scoring.minScore`	Number	No
`steps[].scoring.scoreMode`	String	No
`steps[].id`	String	No
`steps[].groupId`	String	No
`steps[].name`	String	No
`steps[].assessorInstructions`	String	No
`steps[].bodyHtml`	String	No
`steps[].coverMediaId`	String	No
`steps[].options`	Object	No
`steps[].options.isAutoRegistrationEnabled`	Boolean	No
`steps[].options.selfRegistration`	Object	No
`steps[].options.selfRegistration.delay`	Object	No
`steps[].options.selfRegistration.delay.value`	Number	No
`steps[].options.selfRegistration.delay.unit`	String	No
`steps[].options.selfRegistration.enabled`	Boolean	No
`steps[].options.attendanceSheets`	Object	No
`steps[].options.attendanceSheets.number`	Number	No
`steps[].options.attendanceSheets.unit`	String	No
`steps[].message`	String	No
`steps[].assessmentName`	String	No
`steps[].trainingObjective`	String	No
`steps[].title`	String	No
`steps[].type`	String	No
`steps[].medias[]`	Array	No
`steps[].headlineHtml`	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.