Web API

Press shift + S to search API reference.

Collaborators

Update workspace collaborator

patchhttps://api.airtable.com/v0/meta/workspaces/{workspaceId}/collaborators/{userOrGroupId}

Updates the permission level of a collaborator on a workspace.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases:write
User role

Workspace collaborators subject to sharing restrictions

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

Path parameters

workspaceId
string
userOrGroupId
string

Request body

Response format

This endpoint returns an empty response on success.

Error responses

Groups cannot be owners (403)
Cannot assign a group as a workspace owner.
{
"error": {
"message": "Groups cannot be the owners of a workspace",
"type": "INVALID_PERMISSIONS"
}
}
Not workspace collaborator (403)
This route can only be used for users who are already collaborators on the workspace. To add a new collaborator, use the [add workspace collaborator](workspace-addWorkspaceCollaborators) route.
{
"error": {
"message": "Invalid permissions",
"type": "INVALID_PERMISSIONS"
}
}
Sole owner (403)
A workspace must have at least 1 owner who's responsible for the workspace's bill.
{
"error": {
"message": "You can not change the permissions of the sole owner of the workspace.",
"type": "INVALID_PERMISSIONS"
}
}
Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/meta/workspaces/{workspaceId}/collaborators/{userOrGroupId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"permissionLevel": "read"
}'