GEgetstream
product:chat

Add user group members

Changed on

Adds members to a user group. All user IDs must exist. The operation is all-or-nothing.

post/usergroups/{id}/members

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/usergroups/{id}/members
  • 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

Path parameters

idstring required

Request body

as_adminboolean

Whether to add the members as group admins. Defaults to false

member_idsstring[] required

List of user IDs to add as members

team_idstring

Response

AddUserGroupMembersResponse

durationstring required

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0e8699ecb9d0Revision changes
    • info

      added the new optional request property