Remove users from a series or module
Removes one or more users from a Mindtickle series or from a module within it.
Prerequisites
- Authentication and setup: A valid access token.
- Invite users to a series: The users must be invited to the series or module first.
Endpoint
Section titled “Endpoint”POST /services/data/v4.0/mtobjects/Series/SERIES_ID/users/deleteReplace SERIES_ID with the Mindtickle ID of the series.
Base 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 from which you want to remove users. |
Request
Section titled “Request”| Parameter | Type | Required | Description |
|---|---|---|---|
moduleId |
string | Required to remove users from a module | Mindtickle ID of the module from which you want to remove users. The request examples send this field as module_id. |
userids |
Array[string] | Conditional | Mindtickle IDs of users that you want to remove from a series or module. Send each ID as a separate string in the JSON array. |
usernames |
Array[string] | Conditional | Mindtickle usernames or email addresses of the users that you want to remove from a series or module. |
Request example
Section titled “Request example”Confirm the module field name before using the module-removal examples.
{ "module_id": "1234567890123456101", "userids": ["123456789abcd102", "123456789abcd103", "123456789abcd104"]}Or:
{ "module_id": "1234567890123456101", "usernames": ["alex.fry@example.com", "anna.cruz@example.com", "james.smith@example.com"]}Response
Section titled “Response”Returns 200 OK with the message Users removed from series/module successfully.
Errors
Section titled “Errors”| Status | Error |
|---|---|
400 |
Invalid request. |
401 |
Invalid token. |
404 |
Invalid seriesid/moduleid/userid/username. |
429 |
Too many calls. Retry after 5 min. |
500 |
Internal server error. |
- Limits: You can remove a maximum of 500 users per request.
- Identifier choice: You must provide either
useridsorusernames. - Module removal:
moduleIdis required only when you want to remove users from a module. It is not required when you want to remove users from a series. - Module field name: Confirm whether the module-removal request requires
module_idormoduleIdwith Mindtickle Support before submitting it. JSON field names are case-sensitive; do not try both names on a write request. - Usernames: Provide the usernames of the users if UID is enabled for your Mindtickle instance. Provide their email address if UID is not enabled.