36360learning
Paths

Create a path

Changed on

🔑

Required OAuth scope: paths:write.

Creates a new path in the platform.

post/api/v2/paths

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/paths
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Headers

360-api-version'v2.0' required

The version of the API.

Request body multipart/form-data

authorIdstring ObjectId required

The unique ID of the main author of the path.

certificateIdstring ObjectId

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

groupIdstring ObjectId required

The unique ID of the owner group of the path.

namestring required

The title of the path.

coAuthorIdsstring[]

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

descriptionstring

The description of the path.

additionalInformationstring

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.

coverPicturestring ObjectId

The unique ID of the cover picture of the path.

defaultLang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'vm' | 'zh' | 'am_ET' | 'bn' | 'bs' | 'ca' | 'cy' | 'en_CA' | 'en_GB' | 'es_AR' | 'es_MX' | 'et' | 'fr_CA' | 'gr' | 'gu' | 'he_IL' | 'hy' | 'in' | 'kk' | 'km' | 'lo' | 'lv' | 'mi' | 'mn_MN' | 'mr' | 'ms' | 'my_MM' | 'nn_NO' | 'or' | 'pa' | 'pt_BR' | 'pt_MZ' | 'rn_BI' | 'rs' | 'sa' | 'si' | 'ta' | 'tc' | 'te' | 'tl_PH' | 'ur' | 'uz' | 'yo_NG' | 'zh_tw'

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

Example request

{
  "authorId": "507f1f77bcf86cd799439011",
  "certificateId": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439011",
  "name": "Employee Onboarding",
  "coAuthorIds": [
    "507f1f77bcf86cd799439011"
  ],
  "description": "This path will teach you how to onboard a new employee!",
  "additionalInformation": "Training content 203",
  "coverPicture": "507f1f77bcf86cd799439011"
}

Response

Returns the information about the created path.

authorIdstring ObjectId required

The unique ID of the main author of the path.

certificateIdstring ObjectId

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

groupIdstring ObjectId required

The unique ID of the owner group of the path.

_idstring ObjectId required

The unique ID of the path.

coAuthorIdsstring[] required

The list of co-author IDs in an array.

createdAtstring date-time required

The date and time when the path was created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

defaultLang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'am_ET' | 'bn' | 'bs' | 'ca' | 'cy' | 'en_CA' | 'en_GB' | 'es_AR' | 'es_MX' | 'et' | 'fr_CA' | 'gu' | 'he_IL' | 'hy' | 'kk' | 'km' | 'lo' | 'lv' | 'mi' | 'mn_MN' | 'mr' | 'ms' | 'my_MM' | 'nn_NO' | 'or' | 'pa' | 'pt_BR' | 'pt_MZ' | 'rn_BI' | 'si' | 'ta' | 'te' | 'tl_PH' | 'ur' | 'uz' | 'yo_NG' | 'zh_tw' | 'el' | 'hi' | 'sr' | 'ar' | 'vi' | 'zh_HANT' required

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

modifiedAtstring date-time required

The date and time when the path was last updated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

namestring required

The title of the path.

sourceLang'bg' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'ht_HT' | 'hu' | 'id' | 'it' | 'ja' | 'kar_MM' | 'ko' | 'lt' | 'mh_MH' | 'nl' | 'nl_BE' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'rw_RW' | 'sk' | 'sl' | 'so_SO' | 'sv' | 'sw_KE' | 'th' | 'ti_ET' | 'tr' | 'uk' | 'zh' | 'am_ET' | 'bn' | 'bs' | 'ca' | 'cy' | 'en_CA' | 'en_GB' | 'es_AR' | 'es_MX' | 'et' | 'fr_CA' | 'gu' | 'he_IL' | 'hy' | 'kk' | 'km' | 'lo' | 'lv' | 'mi' | 'mn_MN' | 'mr' | 'ms' | 'my_MM' | 'nn_NO' | 'or' | 'pa' | 'pt_BR' | 'pt_MZ' | 'rn_BI' | 'si' | 'ta' | 'te' | 'tl_PH' | 'ur' | 'uz' | 'yo_NG' | 'zh_tw' | 'el' | 'hi' | 'sr' | 'ar' | 'vi' | 'zh_HANT' required

The language in which the path is created.

status'archived' | 'published' required

The status of the path.

additionalInformationstring

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.

coverPicturestring ObjectId

The unique ID of the cover picture of the path.

descriptionstring

The description of the path.

Example response

{
  "authorId": "507f1f77bcf86cd799439011",
  "certificateId": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439011",
  "_id": "507f1f77bcf86cd799439011",
  "coAuthorIds": [
    "507f1f77bcf86cd799439011"
  ],
  "name": "Employee Onboarding",
  "steps": [
    {
      "_id": "507f1f77bcf86cd799439011"
    }
  ],
  "translations": [
    {
      "lang": "fr",
      "translatorIds": [
        "507f1f77bcf86cd799439011"
      ],
      "translatedFields": {
        "name": "Accueil des employés",
        "description": "Ce chemin vous apprend à intégrer un nouveau collaborateur !"
      }
    }
  ],
  "additionalInformation": "Training content 203",
  "coverPicture": "507f1f77bcf86cd799439011",
  "description": "This path will teach you how to onboard a new employee!"
}

Changes

  • d827a4a84180Revision changes
    • breaking

      added subschema #3: Lock Stats Not Enabled to the response body oneOf list for the response status

    • info

      added the new optional request property //

    • info

      added the required property // to the response with the status