PATCH /api/v1/programs/sessions/{session_id}
This route allows you to modify more fields in a program session and will be updated regularly to allow for an update of any and all fields.
Fields that can be edited:
startDate
: date at which the programSession is supposed to startendDate
: date at which the programSession is supposed to endtutors
: an array of the emails of users that will be tutors of the programSessionname
: name of the programSessionuserLimit
: (optional) if there is a limit to the number of users that can freely register to this programSessionemail
: array, to modify the sending date of an email (if there is such a step in the programSession).customFields
: (optional) if you have customFields activated for your programSessions, you can edit them.
Servers
- https://app.360learning.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
session_id |
String | Yes |
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 |
---|---|---|---|
endDate |
String | No | |
customFields[] |
Array | No | |
customFields[]. value |
String | No | |
customFields[]._id |
String | No | |
email[] |
Array | No | |
email[].position |
Number | No | |
email[].sendingDate |
String | No | |
name |
String | No | |
sessionCustom |
String | No | |
userLimit |
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.