Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Groups

Update group

groups.update(strgroup_id, GroupUpdateParams**kwargs) -> GroupResponse
PATCH/v1/groups/{group_id}

Partially updates a group’s name or external reference ID. Returns 404 if the group does not belong to the authenticated organization.

ParametersExpand Collapse
group_id: str

Unique group identifier (grp_*)

external_reference_id: Optional[str]
maxLength255
name: Optional[str]
maxLength255
minLength1
ReturnsExpand Collapse
class GroupResponse: …

Response containing a single group resource.

data: Group
id: str

Prefixed group identifier (grp_<base64-encoded-uuid>).

created_at: Optional[datetime]

Group creation timestamp (ISO 8601, UTC).

formatdate-time
external_reference_id: str

Stable identifier for this group in the integrator’s own system.

maxLength255
name: str

Human-readable group name.

maxLength255
organization_id: str

Prefixed organization identifier (org_<base64-encoded-uuid>).

updated_at: Optional[datetime]

Last-update timestamp (ISO 8601, UTC).

formatdate-time

Update group

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
group_response = client.groups.update(
    group_id="grp_abc123def456",
    external_reference_id="mol_seg_001_v2",
    name="Tier 1 (renamed)",
)
print(group_response.data)
{
  "data": {
    "id": "grp_abc123def456",
    "organization_id": "org_abc123def456",
    "name": "Tier 1 (renamed)",
    "external_reference_id": "mol_seg_001_v2",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-16T09:12:00Z"
  }
}
Returns Examples
{
  "data": {
    "id": "grp_abc123def456",
    "organization_id": "org_abc123def456",
    "name": "Tier 1 (renamed)",
    "external_reference_id": "mol_seg_001_v2",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-16T09:12:00Z"
  }
}