Web API

Press shift + S to search API reference.

User groups

Move user groups

posthttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/moveGroups

Batch move user groups between two enterprise accounts belonging to the same organization.

This endpoint can only be used if your enterprise account has the Enterprise Hub feature enabled.

If the target enterprise account has the invites settings restricted to org unit members, group members who are non-org unit members will be removed when the user groups are moved.

For more information about invites settings, please see our support article.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.groups:manage
User role

Enterprise admin

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

Path parameters

enterpriseAccountId
string

Request body

targetEnterpriseAccountId
string

ID of the target enterprise account of the move. The target enterprise account must be in the same Hub-enabled organization as the source enterprise account, and you must have admin rights over the target enterprise account.

groupIds
array of strings

ID of the groups to be moved. Up to 100 groupIds can be provided.

Response format

errors
array of the below object
id
string

A user group ID

type
string
message
string
movedGroups
array of the below object
id
string

A user group ID

removedUserIds
optional<array of strings>

A list of group members removed from the group as part of the move. Only returned when the target enterprise account has the invites settings restricted to org unit members.

Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/moveGroups" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"groupIds": [
"ugp1mKGb3KXUyQfOZ",
"ugp1mKGb3KXUyQfOZ",
"ugpR8ZT9KtIgp8Bh3",
"ugp1UdbspZKMrIOjk"
],
"targetEnterpriseAccountId": "entUBq2RGdihxl3vU"
}'
200 – Response (example)
{
"errors": [
{
"id": "ugp1mKGb3KXUyQfOZ",
"message": "Duplicate group",
"type": "DUPLICATE"
},
{
"id": "ugpR8ZT9KtIgp8Bh3",
"message": "Group not found",
"type": "NOT_FOUND"
},
{
"id": "ugp1UdbspZKMrIOjk",
"message": "Group is not managed by the enterprise account",
"type": "INVALID_PERMISSIONS"
}
],
"movedGroups": [
{
"id": "ugp1mKGb3KXUyQfOZ"
}
]
}