Add or Remove Users from User-Groups using the API

Context

There are a few things to keep in mind when using these API endpoints: First off, you are able to bulk-add users to a group using a single call, but you must make separate calls to remove users from a group. Adding 5 users to one group is a single call. Removing 5 users from 1 group will require 5 API calls.

Using the API to add and remove users could also have unintended consequences for verification and should be used cautiously. Using the UI to remove members from groups will prompt the user to re-assign content for verification if required. Using the API could randomly reassign content if the user unintentionally removes all users from a user-group, for example. (To be confirmed)

Add Users to a User-Group

POST api/v1/groups/{groupId}/members

Example Request Payload:

["bcumens@getguru.com", "rmiller@getguru.com", "jchappelle@getguru.com"]

A successful response will be an array of User objects representing the users of each of the emails in the request.

An unsuccessful response will say something like "At least one member is required" or "User must be a team member" ... You may NOT invite new members to the team using this endpoint.

Remove UseR From a User-Group

DELETE api/v1/groups/{groupId}/members/{email}

No request payload, each email must be passed in one call at a time through the call above.

⚠️Use this endpoint with caution ⚠️
Removing a user from a group can remove their access to cards and make them lose their verifier assignment. Adding them back to the group doesn't restore them as the verifier, so make sure to only remove users from groups when you really mean to. If you're adding the user to some groups and removing from others, we recommend doing the additions first to reduce the chance of the user temporarily losing access to cards they verify and becoming unassigned.