Skip to main content
PATCH
Rename a group or set its members

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

group_id
string
required

The group's id, from GET /v1/groups

Required string length: 1 - 64

Body

application/json
member_ids
string[] | null

Its users from now on, replacing the ones it has (an empty list removes them all), as /v1/objects/user/records ids them. Leave it out to keep the members.

Maximum array length: 1000
Required string length: 1 - 128
name
string | null

A new name. Refused (409) when another group already has it or reads as it.

Required string length: 1 - 255

Response

200 - application/json

Successful Response

created_at
string<date-time> | null
required

When the group was made

id
string
required

The group's id

member_count
integer
required

The users in the group

members
GroupMember · object[]
required

The users in the group, in the order they were added

name
string
required

The group's name, as Settings > Team > Groups shows it

type
enum<string>
required

custom: a group someone made. role or department: the group the app keeps for every user with that role or department on their Team page record, named after it

Available options:
custom,
role,
department
updated_at
string<date-time> | null
required

When the group's name last changed; adding or removing a member leaves it as it was