Update group

client.groups.update(, ?, ?): GroupResponse { data }

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

groupID: string

Unique group identifier (grp_*)

body: GroupUpdateParams { external_reference_id, name }

external_reference_id?: string | null

maxLength255

name?: string | null

maxLength255

minLength1

ReturnsExpand Collapse

GroupResponse { data }

Response containing a single group resource.

data: Group { id, created_at, external_reference_id, 3 more }

id: string

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

created_at: string | null

Group creation timestamp (ISO 8601, UTC).

formatdate-time

external_reference_id: string

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

maxLength255

name: string

Human-readable group name.

maxLength255

organization_id: string

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

updated_at: string | null

Last-update timestamp (ISO 8601, UTC).

formatdate-time

Update group

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const groupResponse = await client.groups.update('grp_abc123def456', {
  external_reference_id: 'mol_seg_001_v2',
  name: 'Tier 1 (renamed)',
});

console.log(groupResponse.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"
  }
}