Web API

Press shift + S to search API reference.

Users

Delete user by id

deletehttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/users/{userId}

Delete ELA enterprise account internal users and "claiming" enterprise account managed users.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.user:write
User role

Enterprise admin

Billing plansEnterprise (pre-2023.08 legacy plan), Enterprise Scale

Path parameters

enterpriseAccountId
string
userId
string

Response format

This endpoint returns an empty response on success.

Error responses

Action on self failure (403)
Don't deactivate yourself or you might lose access. If action must be performed, add another admin.
{
"error": {
"message": "Cannot perform action on self",
"type": "INVALID_PERMISSIONS"
}
}
Cannot delete sole owner (403)
If a workspace has more than one collaborator, it must have at least one owner. So the sole owner cannot be deleted.
{
"error": {
"message": "Cannot delete sole owner of a workspace with other collaborators",
"type": "INVALID_PERMISSIONS"
}
}
External user account (403)
Cannot modify external user state since they are not considered part of the enterprise account.
{
"error": {
"message": "User does not belong to the enterprise email domain",
"type": "INVALID_PERMISSIONS"
}
}
FLA account error (403)
The provisioned and deactivated states apply only to ELA and "claiming" enterprise accounts. FLA users are always provisioned.
{
"error": {
"message": "State modification is not enabled for FLA enterprise accounts",
"type": "INVALID_PERMISSIONS"
}
}
Non-managed user account (403)
Can only manage information of managed users.
{
"error": {
"message": "User is not managed by the enterprise account",
"type": "INVALID_PERMISSIONS"
}
}