Add group members

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

Adds members to a custom group, up to 200 per request. Their workspace role updates right away.

Only active members of the workspace can join a group. Pending invitees, guests, and the workspace owner can't. To add someone who isn't a member yet, invite them with Invite workspace member and pass group_id. If any address can't be added, nobody is added.

Adding someone who's already 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.

Groups need the Business plan or higher. Below it, this returns a 402.

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."
}