Web API

Press shift + S to search API reference.

Users

Revoke admin access

posthttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/users/revokeAdminAccess

Revokes admin access from users. To use this endpoint, provide either the user's id or email in the request body. If both are supplied, the email will be ignored.

In the example request provided, the first two users are successfully processed while all of the remaining users are not processed and are returned in the errors array with the reason why they were not able to be processed.

Note that you can only revoke directly assigned admin access.

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

Request body

users
array of the below object
id
optional<string>

A user ID

email
optional<string>

Response format

errors
array of the below object
id
optional<string>

A user ID

type
string
email
optional<string>
message
optional<string>
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/users/revokeAdminAccess" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"users": [
{
"id": "usrL2PNC5o3H4lBEi"
},
{
"email": "foo@bar.com"
},
{
"email": "bam@bam.com"
},
{
"id": "usrsOEchC9xuwRgKk"
},
{
"email": "foo@bam.com"
}
]
}'
200 – Response (example)
{
"errors": [
{
"email": "bam@bam.com",
"message": "User not found",
"type": "NOT_FOUND"
},
{
"id": "usrsOEchC9xuwRgKk",
"message": "User not found",
"type": "USER_ID_NOT_FOUND"
},
{
"email": "foo@bam.com",
"message": "User is not an assigned admin",
"type": "USER_NOT_ASSIGNED_ADMIN"
}
]
}