GEgetstream
product:chat

Create user group

Changed on

Creates a new user group, optionally with initial members

post/usergroups

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/usergroups
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Request body

descriptionstring

An optional description for the group

idstring

Optional user group ID. If not provided, a UUID v7 will be generated

member_idsstring[]

Optional initial list of user IDs to add as members

namestring required

The user friendly name of the user group

team_idstring

Optional team ID to scope the group to a team

Response

CreateUserGroupResponse

durationstring required

Changes