Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels (Account-level)
Chat Messages
Chatbot Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Reports
Roles
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
SMS
Provider Exchange
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
post

/chat/users/{userId}/channels

Use this API to create a channel for a user. For user-level apps, pass the me value instead of the userId parameter.

Zoom chat channels allow users to communicate via chat in private or public groups.

Scopes: chat_channel:write or chat_channel:write:admin
Rate Limit Label: Medium

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 the Edit permission for the Chat channels feature.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

Schema
object
name
string

Name of the channel.

1 validation
type
integer

Type of the channel. The value can be one of the following:
1: Private channel. In this type of channel, members must be invited to join a channel.
2: Private channel with members that belong to one Zoom account. Members in this channel should be invited and the members should be from the same organization.
3: Public channel. Anyone can search for this channel and join the channel.
4: New chat. This is an instant channel which can be created by adding members to a new chat.

1 validation
members
array[object]

Member(s) to include in the channel. A max of 5 members can be added to the channel at once with this API.

Responses

Status Code: 201
Channel created.

1 Example
Schema
object
id
string

Channel ID: Unique Identifier of the Channel.

name
string

Channel name.

type
integer

Channel type.

jid
string

Channel JID.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
userId
$$.env
1 variable not set
oauth_access_token