Invite to Channel
Adds a user or bulk users to the channel.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
For a user to invite others, they must match at least one of the following premises:
If the user is part of a room of any type and has the
add-user-to-joined-room
permission.If the user is part of a public room (
t: 'c'
) and has theadd-user-to-any-c-room
permission.If the user is part of a private room (
t: 'p'
) and has theadd-user-to-any-p-room
permission.
Add a user
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The channel ID. |
|
| The user ID to invite to the channel. |
Example Call
Example Response
Add bulk users
Body Parameters
Key | Example Value | Description |
---|---|---|
|
| The channel ID. |
|
| The user IDs of the users to invite to the channel |
Example Call
Example Response
Change Log
Version | Description |
---|---|
0.48.0 | Added |
Last updated