Web API

Press shift + S to search API reference.

Shares

Manage share

patchhttps://api.airtable.com/v0/meta/bases/{baseId}/shares/{shareId}

Manages share state.

Requirements

AuthenticationPersonal access token, OAuth integration
ScopeworkspacesAndBases.shares:manage
User role

Base editor with caveats, see state below

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

Path parameters

baseId
string
shareId
string

Request body

state
"enabled" | "disabled"

When enabling a share a user is subject to sharing restrictions. These restrictions are not applicable when disabling a share.

Response format

This endpoint returns an empty response on success.
Request (example)
Copy
$
curl -X PATCH "https://api.airtable.com/v0/meta/bases/{baseId}/shares/{shareId}" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"state": "disabled"
}'