Remove group share

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

Stops sharing the app with a group.

Members who can use the app only through this group lose access. Members with a direct role, or another shared group, keep access at the highest role they still have. If the call fails, the share is kept, so you can safely retry.

This works on any plan, so you can remove shares after your workspace's plan no longer includes groups. You need editor access to the app, and an editor or admin role in the app's workspace.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

delete/api/apps/{app_id}/group-shares/{share_id}

Path parameters

app_idstring required

ID of the app.

ID of the app.

share_idstring required

ID of the share, as id in the response of List group shares.

ID of the share, as id in the response of List group shares.

Response

The share was removed.

successboolean required

Always true. A removal that doesn't happen returns an error instead.

Example response

{
  "success": true
}

Changes

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