Invite groups to a module
Invites one or more Mindtickle groups to a module of a Mindtickle series.
Prerequisites
- Authentication and setup: A valid access token.
- Create a group: The groups must exist.
- List all modules in a series: The module must exist, and you need its ID and its series ID.
Endpoint
Section titled “Endpoint”POST /services/data/v4.0/mtobjects/Series/SERIES_ID/Module/MODULE_ID/Groups/addBase URL: the standard REST host for your region. See Base URLs.
Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.
Path parameters
Section titled “Path parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
SERIES_ID |
string | Required | Mindtickle ID of the series that you want to assign to one or more groups. |
MODULE_ID |
string | Required | Mindtickle ID of the module that you want to assign to one or more groups. |
Request
Section titled “Request”| Parameter | Type | Required | Description |
|---|---|---|---|
groupIds |
Array[string] | Required | Mindtickle IDs of the groups that you want to invite to the module. Send each ID as a separate string in the JSON array. |
Request example
Section titled “Request example”{ "groupIds": ["1234567890123456101", "1234567890123456102", "1234567890123456103"]}Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
processId |
string | Mindtickle process ID. Pass it as an item in the processIds array when checking process status. |
Response example
Section titled “Response example”{ "processId": "1234567890123456104"}- Async processing: The request is queued, and the response returns a process ID you use to check the result.
- Limits: You can invite a maximum of 20 groups per request.