Sign in

Update group share

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

Changes the app role a group share gives the group's members.

Send the whole new value. Leaving role out, or sending null, stops assigning a role, so members get the default user role. Lowering a group's role doesn't lower a member who has a higher role directly or through another shared group. Members' access usually updates right away, and always by their next sign-in. Sending the role the share already has changes nothing.

You need editor access to the app, and an editor or admin role in the app's workspace. Your workspace's plan must include workspace groups.

<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>

put/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.

Request body

rolestring nullable

App role the group's members get, one of the roles defined on the app's User entity. Send null, or leave role out, to stop assigning a role, so members get the default user role.

Example request

{
  "role": "admin"
}

Response

The share with its new role.

idstring required

ID of the share.

rolestring nullable required

App role the share now gives the group's members, or null when it assigns none.

Example response

{
  "id": "68d1c2e4a9b7f3001e5c8a41",
  "role": "admin"
}

Changes

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