POST /chat/users/{userId}/channels/{channelId}/members
A channel can have one or multiple members. Use this API to invite members that are in a user's contact list to a channel. The maximum number of members that can be added at once with this API is 5.
Scope: chat_channel:write:admin
Rate Limit Label: Medium
For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has Edit permission for Chat Channels.
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Unique identifier of the user who is the owner of this channel. |
channelId |
String | Yes |
Channel ID: Unique Identifier of the channel. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
members[] |
Array | No |
Members of a channel. You can invite up to a max number of 5 members with a single API call. |
members[].email |
String | Yes |
Email adress of the member. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.