Invite as members
Invites one or more users as members to a group channel. Users can join a group channel immediately after receiving an invitation, without having to accept it. To give users an option to accept or decline an invitation, see update default channel invitation preference or update channel invitation preference. See this page to learn more about channel types.
Note: By default, blocked users are included when sending invitations. If you wish to exclude blocked users, contact our sales team.
The following table lists the parameters that this action supports.
Specifies the URL of the channel.
The following table lists the properties of an HTTP request that this action supports.
array of strings
Specifies an array of one or more user IDs to invite to the channel. Up to 100 users can be invited at a time. The
array of objects
Specifies a list of one or more
Specifies one or more
Specifies one or more key-value pair items which set the channel's hidden status for each user. The value in
Specifies the ID of a user who invites other users to the channel. The inviter isn't automatically registered to the channel as a member, so you should specify the ID of the inviter in the
If successful, this action returns a group channel resource in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.