Create a path

Required OAuth scope: paths:write.

Creates a new path in the platform.

Body Params
string
required

The unique ID of the main author of the path.

string

The unique ID of the certificate outline from which certificates are issued upon path completion.

string
required

The unique ID of the owner group of the path.

string
required
length ≥ 1

The title of the path.

coAuthorIds
array of strings

The list of co-author IDs in an array. No co-authors are added if empty.

coAuthorIds
string
length ≥ 1

The description of the path.

string
length ≥ 1

A custom field to store information available only in the Advanced settings of the path editor, the CSV exports, and the API. This information is not displayed to learners on the platform.

string
enum

The language in which the path is displayed when the learner’s profile language is not available.

estimatedWeeklyCommitment
object

An estimated weekly time commitment in hours for learners on the path. This value is set in the field Estimated weekly commitment in the path settings and displayed to learners on the path homepage.

options
object

A set of options to customize the behavior of the path.

Headers
string
enum
required

The version of the API.

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json