Remove users from a group

Removes one or more users from a Mindtickle group, by Mindtickle user ID or by username.

Prerequisites

POST /services/data/v4.0/mtobjects/Group/GROUP_ID/users/delete

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Parameter	Type	Required	Description
`GROUP_ID`	string	Required	Mindtickle ID of the group from which you want to remove users.

Parameter	Type	Required	Description
`userids`	Array[string]	Required if `usernames` is not sent	Mindtickle IDs of users that you want to remove from a group.
`usernames`	Array[string]	Required if `userids` is not sent	Mindtickle usernames or email addresses of the users that you want to remove from a group.

By Mindtickle user ID:

{
  "userids": ["123456789abcd101", "123456789abcd102", "123456789abcd103"]
}

By username:

{
  "usernames": ["alex.fry@example.com", "anna.cruz@example.com", "james.smith@example.com"]
}

On success the endpoint returns HTTP 200 with the message “Users removed from group successfully.”

Status	Response message
`400`	Invalid request.
`401`	Invalid token.
`404`	Invalid groupid/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.
Validation: You must provide either userids or usernames. Send each ID as a separate string in the JSON array.
Usernames: Provide the username of each user if UID is enabled for your Mindtickle instance, and their email address if UID is not enabled.
Field name: Send the list of Mindtickle user IDs as userids, all lowercase. This is the field defined by the request model. Do not change it to userIds.