Web API

Press shift + S to search API reference.

Collaborators

Add interface collaborator

posthttps://api.airtable.com/v0/meta/bases/{baseId}/interfaces/{pageBundleId}/collaborators

Use this to add a collaborator to an interface.

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
pageBundleId
string

Request body

collaborators
array of any of the below objects

This endpoint accepts two types of collaborators: individual user and group. This route currently supports adding only one collaborator at a time.


permissionLevel
"read" | "comment" | "edit"
group
optional<any>
user
object
id
string

A user ID


permissionLevel
"read" | "comment" | "edit"
user
optional<any>
group
object
id
string

A user group ID

Response format

This endpoint returns an empty response on success.