Bulk edit of membership in user group

Add and remove members in one request. For example, remove user A and add user B. You can add or remove up to 500 users at a time.

Required scope

organizations:groups:write

Rate limiting

Level 1 per item. For example, if you want to add 10 users and remove 5, the rate limiting applicable will be 750 credits. This is because each user addition or deletion takes Level 1 rate limiting of 50 credits, so 15 * 50 = 750.

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

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

The ID of an organization.

string
required

The ID of a user group.

Body Params
membersToAdd
array of strings

List of user identifiers (can be email or ID) to add to the user group.

membersToAdd
membersToRemove
array of strings

List of user identifiers (can be email or ID) to remove from the user group.

membersToRemove
Responses

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