Sign in

Delete workspace group

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

Deletes a group. Its members lose the role it granted, and apps shared with the group stop being shared through it.

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.

You can't make a change that removes your own admin access. Deleting 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>

delete/api/workspace/groups/{group_id}

Path parameters

group_idstring required

ID of the group to delete. Get it from id in List workspace groups.

ID of the group to delete. Get it from id in List workspace groups.

Query parameters

workspaceIdstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Response

The group was deleted.

status'success' required

Always success.

messagestring required

Short confirmation. Its wording can change, so don't parse it.

Example response

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

Changes

Changed in 1 of the 38 revisions of this API.1