Remove Users from Group

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Path Parameters

ParameterTypeDescriptionRequired
idstringUUID of the group.Yes

Request Body

KeyTypeDescriptionRequired
user_idsarrayList of user UUIDs to remove. Users not currently in the group are silently ignored. This operation is idempotent.Yes
{
  "user_ids": ["9e34b87d-79ca-4dc3-ac42-8ce9ebe8be82"]
}

Response

Returns the updated group with its current members, reflecting all removals.

Errors

StatusMessageDescription
404Group not foundThe group does not exist or does not belong to this organization.
422Parameter user_ids is requiredThe user_ids field is missing.
Path Params
string
required
Body Params
user_ids
array of strings
required
user_ids*
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json