Web API

Press shift + S to search API reference.

Collaborators

Update collaborator base permission

patchhttps://api.airtable.com/v0/meta/bases/{baseId}/collaborators/{userOrGroupId}

Updates the permission level of a collaborator on a base.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases:write
User role

Base collaborators subject to sharing restrictions

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

Path parameters

baseId
string
userOrGroupId
string

Request body

Response format

This endpoint returns an empty response on success.

Error responses

Not base collaborator (403)
This route can only be used for users who are already collaborators on the base. To add a new collaborator, use the [add base collaborator](base-addBaseCollaborators) route.
{
"error": {
"message": "Invalid permissions",
"type": "INVALID_PERMISSIONS"
}
}
Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/meta/bases/{baseId}/collaborators/{userOrGroupId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"permissionLevel": "read"
}'