Update workspace group

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

Renames a group, changes its description, or changes the role it grants. Send only the fields you want to change.

Set role to null to clear it, so the group grants no role. Leave role out to keep it. A new role on a custom group applies to every member right away.

A group whose source is idp gets its name and members from your identity provider, so they can't be changed here. Its role and description can still change. An idp group grants its role only while the workspace uses identity-provider groups. Otherwise its role is stored but grants nothing. You can't make a change that removes your own admin access.

The response's unresolved_count is always 0. Read the real count from List workspace groups.

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": "Brand design",
  "description": "Brand and marketing designers",
  "role": "viewer"
}

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