Update a custom access group

Updates the name and/or description of a custom access group. At least one field must be provided.

Scope-managed groups (type 'scope') cannot be modified via the API — attempting to update one returns 403 Forbidden.

PATCH /api/v1/access-groups/{groupId}

Bearer token

curl 'https://api.sotion.so/api/v1/access-groups/123e4567-e89b-42d3-a456-426614174000' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "example",
  "description": "example"
}'

{
  "data": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "name": "example",
    "description": "example",
    "type": "custom",
    "memberCount": 1,
    "createdAt": "2026-01-01T12:00:00Z",
    "updatedAt": "2026-01-01T12:00:00Z"
  }
}

Access group updated.

Path parameters

· 1

groupId string · uuid required

UUID of the access group. Get group IDs from listAccessGroups or createAccessGroup responses.

Body

· UpdateAccessGroupRequest

required application/json

name string · min length: 1· max length: 100

New display name. Must be unique per site. 1-100 characters.

description string · max length: 500· nullable

New description, or null to clear. Max 500 characters.

Path parameters

Body

Responses