Skip to main content
PATCH
Update an existing user group

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Path Parameters

groupId
string
required

Body

application/json
name
string

Name of the user group

capacity
number

Group capacity (minimum 1)

userId
string
deprecated

User to assign or deassign from group. Deprecated: send the full userIds set instead, so the result does not depend on how current your copy of the member list is.

userIds
string[]

Full desired set of group member IDs. Replaces the membership in one transaction.

mainGroupHostId
string | null

Main host user ID for the group (can be null to remove)

Response

User group updated successfully

id
string
required
name
string
required
capacity
number
required
users
object[]
required
userIds
string[]
required
queueId
string
required
createdAt
string
required
updatedAt
string
required
mainGroupHost
object | null
mainGroupHostId
string | null
deletedAt
string | null