Add a new base collaborator. Despite the name, this route currently only supports adding one collaborator at a time.
Collaborators
Add base collaborator
post
https://api.airtable.com/v0/meta/bases/{baseId}/collaborators
Authentication | Personal access token, OAuth integration |
Scope | workspacesAndBases:write |
User role | Base collaborators subject to sharing restrictions |
Billing plans | Enterprise (pre-2023.08 legacy plan), Enterprise Scale |
array of any of the below objects This endpoint accepts two types of collaborators: individual user and group.
|
Response format
This endpoint returns an empty response on success.
Error responses
Add more than one collaborator (403)
This route currently supports adding only one collaborator at a time.
{"error": {"message": "You are only permitted to add one collaborator at a time","type": "INVALID_PERMISSIONS"}}
Email not verified (403)
The userId must correspond to a verified account.
{"error": {"message": "User must be active and email verified","type": "INVALID_PERMISSIONS"}}
Request (example)
Copy
$curl -X POST "https://api.airtable.com/v0/meta/bases/{baseId}/collaborators" \-H "Authorization: Bearer YOUR_TOKEN" \-H "Content-Type: application/json" \--data '{"collaborators": [{"permissionLevel": "edit","user": {"id": "usr00000000000000"}}]}'