POST /api/v1/programs/{template_id}/sessions/
Create a program session for the provided program.
Dates must be provided as ISO 8601 complete date plus hours, minutes and seconds. See w3c standards for further details.
Returns :
- id of the session created
Important notes :
- Program sessions created via this POST will honour company-wide settings (see "Advanced Options" in the workspace settings) regarding those options:
- By default, courses and programs are in the coaches' library for the public groups.
- By default, courses and programs are in the catalog for the public groups.
- for program templates including webinars, face-to-face or emails sessions, use raw - JSON body. Sample code below.
- for program templates that do not include webinars, face-to-face or emails sessions, it is possible to use x-www-form-urlencoded body.
Global Parameters:
startDate: Start date of the session, provided as ISO 8601 string: YYYY-MM-DDThh:mm:ssTZD
Parameters for face-to-face events:
classroom: Optional. Array of JSON objects with information for each Face to Face event
Parameters for webinar events:
webinar: Optional. Array of JSON objects with information for each webinar event
Parameters for email events:
Changelog:
- November 21: Update on the
sendingDateparameter. - April 20: Added the
sendAutomatedRemindersoptional parameter. - Dec 18: this route can now also handle program templates with webinars, face-to-face or emails events, using raw JSON.
- Nov 18: the parameter "userLimit" is now available.
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id |
String | Yes |
Id of the template |
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 |
|---|---|---|---|
classroom[] |
Array | No | |
classroom[].endDate |
String | No | |
classroom[].team[] |
Array | No | |
classroom[].location |
String | No | |
classroom[].startDate |
String | No | |
classroom[].position |
Number | No | |
endDate |
String | No | |
email[] |
Array | No | |
email[].position |
Number | No | |
email[].sendingDate |
String | No | |
name |
String | No | |
sessionCustom |
String | No | |
userLimit |
Number | No | |
webinar[] |
Array | No | |
webinar[].endDate |
String | No | |
webinar[].team[] |
Array | No | |
webinar[].location |
String | No | |
webinar[].startDate |
String | No | |
webinar[].position |
Number | No | |
startDate |
String | No | |
tutors[] |
Array | 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.