<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Removes members from a custom group, up to 200 per request.

Each affected member's role is worked out again from their other groups. A member left in no group becomes a viewer, or gets the workspace's SSO default role when SSO is set up.

Removing someone who isn't in the group changes nothing, so retrying is safe. A group whose source is idp gets its name and members from your identity provider, so they can't be changed here. You can't make a change that removes your own admin access. Removing members works on any plan, so you can take groups apart after a downgrade.

This is limited to 60 requests per minute, shared with the other endpoints that change groups or their members. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren't accepted.</Note>

{
  "emails": [
    "dana@acme.com",
    "sam@acme.com"
  ]
}

{
  "status": "success",
  "message": "Members added to group."
}