Sign in

Remove app user

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

Removes a user from the app.

The user loses access straight away, including any editor access they had to the app. Their invitation or access request is deleted too, so they aren't added back the next time they sign in, unless they belong to a group shared with the app, which lets them back in through the group. To give them access again, invite them with Invite app users. You can't remove the app's owner.

Removing a user triggers the app's webhooks for the User entity.

<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}/entities/User/{user_id}

Path parameters

user_idstring required

ID of the user, as id in the response of List app users.

ID of the user, as id in the response of List app users.

app_idstring required

ID of the app the user belongs to.

ID of the app the user belongs to.

Response

The user was removed.

successboolean required

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

Example response

{
  "success": true
}

Changes

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