POST /chat/users/{userId}/channels
Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.
Scopes:chat_channel:write or chat_channel:write:admin
Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a role that has Edit permission for the Chat channels feature.
Rate Limit Label: Medium
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Unique identifier of the user. |
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 |
Member(s) to include in the channel. A max of 5 members can be added to the channel at once with this API. |
members[].email |
String | Yes |
Member's email address. |
name |
String | No |
Name of the channel. |
type |
Integer | No |
Type of the channel. The value can be one of the following: Valid values:
|
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.