Remove Member from Team
- Print
- DarkLight
- PDF
Remove Member from Team
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/teams.removeMember
Removes a member from a team.
Permission required: edit-team-member
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
"teamId": "63f3efc4b000b6b6d86704b2",
"userId": "rYhzFRd2QZjNwAAXX",
"rooms": [
"JKa7R9zu2DinBhBN9"
]
}object
teamId
string Required
Enter the team ID. Alternatively, enter the teamName parameter and provide the team's name as the value.
userId
string Required
The user ID to remove from the team.
rooms
Array of string
The rooms (IDs) from which the user should be removed.
string
Responses
200
OK
Success
{
"success": true
}object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?