Create workspace group

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

Creates a custom group in a workspace, optionally with a role and its first members.

Every member of a group gets the group's role, and a member of several groups gets the highest of their roles. A group whose role is no_access blocks members who get their role only from it. Leave role out for a group that grants no role.

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 in member_emails can't be added, nothing is created.

Group names are unique within a workspace, ignoring case, so retrying a create that succeeded returns a 400. You can't make a change that removes your own admin access.

The response's unresolved_count is always 0.

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>

{
  "name": "Design team",
  "description": "Product designers",
  "role": "editor",
  "member_emails": [
    "dana@acme.com",
    "sam@acme.com"
  ]
}

{
  "id": "68b4e1d2c9a7f3001e2d4b61",
  "name": "Design team",
  "description": "Product designers",
  "source": "custom",
  "role": "editor",
  "member_count": 12
}