Skip to main content
POST
Create a user group

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.

Body

application/json
name
string
required

The group's name. Refused (409) when another group already has it or reads as it (a role or department group reads as its bare name).

Required string length: 1 - 255
member_ids
string[]

The users to put in it, as /v1/objects/user/records ids them: teammates with a Statisfy login

Maximum array length: 1000
Required string length: 1 - 128

Response

201 - 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