Skip to main content
Zoom Team Chat logo
  • Category: team chat
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 44
  • Triggers: 0
  • Slug: ZOOM_CHAT
  • Version: 20261101_00

Tools

Slug: ZOOM_CHAT_ADD_SHARED_SPACE_MEMBERSAdd members to a Zoom Team Chat shared space by user ID or member ID. Check the returned counts and per-user operation statuses to determine which additions succeeded.

Input Parameters

string
required
Unique ID of the shared space to add members into.
array
required
Email addresses or Zoom user IDs to add to the shared space (1-20 per call, must be unique). Each identifier is added independently - inspect the per-user operation_status in the response to see which adds succeeded, since Zoom returns success even when every add fails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_ARCHIVE_CHANNELSArchive or unarchive up to 10 Zoom Team Chat channels in one call. Returns per-channel failures; success requires failed_channels to be empty.

Input Parameters

string ("archive" | "unarchive")
required
Operation to perform on the channels: ‘archive’ or ‘unarchive’.
array
required
IDs of the channels to archive or unarchive (1-10 per call, must be unique).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_BOOKMARK_MESSAGEAdd or remove a bookmark on a Zoom Team Chat message. Identify the message by message_id plus the conversation it lives in: provide exactly one of to_channel (a channel message) or to_contact (a 1:1 message). Set action to ‘add_bookmark’ (default) or ‘remove_bookmark’. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string ("add_bookmark" | "remove_bookmark")
Whether to add or remove the bookmark on the message.
string
required
The message ID to bookmark or unbookmark. Sent as a query parameter (the API rejects it in the body).
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the 1:1 chat contact the message belongs to. Exactly one of to_channel or to_contact is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_CREATE_CHANNELCreate a new Zoom Team Chat channel for the authenticated user, optionally inviting initial members by email.

Input Parameters

string
required
Channel name (1-256 characters).
integer
Channel type: 1 = invite-only private, 2 = private (org members can be added), 3 = public within the org, 4 = new-chat/instant channel.
object
Existing shared space in which to create the channel. When provided, type must be 1 or 2.
array
Email addresses to invite as initial members (up to 20). External emails become pending Zoom contact invitations, not immediate members.
object
Optional channel settings (member-add, posting, history visibility and @all-mention permissions).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_CREATE_MESSAGE_REMINDERSet a reminder on a Zoom Team Chat message, either after a delay (delay_seconds) or at an absolute time (remind_time). Exactly one of to_channel or to_contact must identify where the message lives, and exactly one of delay_seconds or remind_time must set the timing.

Input Parameters

string
required
The ID of the message to be reminded about.
string
Channel ID the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email address of the 1:1 contact the message belongs to. Exactly one of to_channel or to_contact is required.
string
Absolute reminder time as an RFC3339 timestamp (e.g. 2026-08-01T09:00:00Z). Provide exactly one of remind_time or delay_seconds.
integer
Remind after this many seconds from now (300 seconds to 7,776,000 seconds / 90 days). Provide exactly one of delay_seconds or remind_time.
string
Optional note to attach to the reminder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_CREATE_SHARED_SPACECreate a Zoom Team Chat shared space (a container that groups related channels). A ‘general’ channel is auto-created with it.

Input Parameters

string
Description of the shared space.
string
required
Name of the shared space.
array
Initial members to add to the shared space.
object
Optional shared-space settings (external-user, add-member and create-channel permissions).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_DELETE_CHANNELDelete a Zoom Team Chat channel the user owns or is a member of. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string
required
The channel ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_DELETE_MESSAGEDelete a Zoom Team Chat message the connected user sent, identified by message_id plus the conversation it lives in. Provide exactly one of to_channel (a channel message) or to_contact (a 1:1 message). Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string
required
The ID of the message to delete.
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the 1:1 chat contact the message was sent to. Exactly one of to_channel or to_contact is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_DELETE_MESSAGE_REMINDERDelete the reminder set on a Zoom Team Chat message. Reminders have no id of their own — they are identified by the message_id they belong to. Provide exactly one of to_channel (a channel message) or to_contact (a 1:1 message) to locate the message. Returns {success: true} on success; the API responds with HTTP 204 and an empty body.

Input Parameters

string
required
The message ID whose reminder to delete (reminders have no own id).
string
Channel ID of the channel the message belongs to (query param).
string
Email address of the contact the message belongs to (query param).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_DELETE_SCHEDULED_MESSAGEDelete a scheduled (draft) Zoom Team Chat message before it is sent, identified by draft_id plus the conversation it is addressed to. Provide exactly one of to_channel (a channel draft) or to_contact (a 1:1 draft). Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string
required
The draft ID of the scheduled message to delete (from LIST_SCHEDULED_MESSAGES).
string
Channel ID of the channel the scheduled draft was addressed to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the 1:1 chat contact the scheduled draft was addressed to. Exactly one of to_channel or to_contact is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_DELETE_SHARED_SPACEDelete a Zoom Team Chat shared space. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body. NOTE: the space’s auto-created ‘general’ channel SURVIVES as a regular channel and must be deleted separately with DELETE_CHANNEL.

Input Parameters

string
required
The shared space ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_GET_CHANNELGet full information about a Zoom Team Chat channel, including its settings.

Input Parameters

string
required
The channel ID (from LIST_CHANNELS, SEARCH_CHANNELS, or CREATE_CHANNEL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_GET_CONTACTGet a single Zoom Team Chat contact by email or user ID, optionally with live presence status.

Input Parameters

string
required
Email address, user ID, or member ID of the contact.
boolean
Set true to include the contact’s presence_status (Available, Away, Offline, In_A_Meeting, …).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_GET_MESSAGEGet a Zoom Team Chat message by ID and its channel or 1:1 contact. The response may include a deep-link URL.

Input Parameters

string
required
The message ID to retrieve.
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email, user ID, or member ID of the 1:1 chat contact the message belongs to. Exactly one of to_channel or to_contact is required.
string
Return audio-file download URLs in MP4 format when set to ‘audio/mp4’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_GET_MESSAGE_THREADRetrieve a Zoom Team Chat message thread and replies within a time window. The parent message can be included; replies are limited to 100 per request, with a default of 10.

Input Parameters

string ("desc" | "asc")
Sort order by reply time: ‘desc’ puts the latest reply first, ‘asc’ the oldest. Zoom defaults to ‘desc’.
integer
Maximum number of replies to return (1-100). Zoom defaults to 10.
string
End of the query window, RFC3339. Defaults to the current time when omitted.
string
required
Start of the query window, RFC3339 (e.g. 2026-07-23T00:00:00Z). Required in practice even though Zoom’s docs mark it optional (Zoom returns 400 code 4233 ‘The from cannot be blank.’ otherwise).
string
required
The parent (main) message ID whose thread to retrieve.
boolean
Whether to include emoji reactions on each message. Zoom defaults to false.
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email, user ID, or member ID of the 1:1 chat contact the message belongs to. Exactly one of to_channel or to_contact is required.
boolean
Whether to include @(at) mention items on each message.
boolean
Whether to include rich-text formatting segments on each message.
boolean
Whether to include file attachments on each message. Zoom defaults to false.
boolean
Whether to include the parent (main) message in messages. When false, messages contains replies only. Zoom defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_GET_SHARED_SPACEGet details of a Zoom Team Chat shared space, including its owner and settings.

Input Parameters

string
required
The shared space ID (from LIST_SHARED_SPACES or CREATE_SHARED_SPACE).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_INVITE_CHANNEL_MEMBERSInvite up to five contacts to a Zoom Team Chat channel by email address. The response may include an invitation timestamp and identifiers of members added.

Input Parameters

string
required
Unique ID of the channel to invite members into.
array
required
Email addresses to invite (1-5 per call). External (non-org) emails become pending Zoom contact invitations and stay invisible in the member list until the invitation is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_JOIN_CHANNELJoin a public Zoom Team Chat channel as the authenticated user. Only public (type 3 or 5) channels can be joined this way; private and invite-only channels require an invitation.

Input Parameters

string
required
The channel ID of a public (type 3 or 5) channel to join.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LEAVE_CHANNELLeave a Zoom Team Chat channel. WARNING: if the channel OWNER leaves an invite-only channel they cannot rejoin or delete it afterwards — the channel is orphaned. Owners should delete the channel instead. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string
required
The channel ID to leave.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_BOOKMARKSList the authenticated user’s bookmarked Zoom Team Chat messages, optionally filtered to one channel (to_channel) or one 1:1 contact (to_contact). Omit both filters to list bookmarks across all conversations.

Input Parameters

integer
Number of records per page (max 50).
string
Optional channel ID filter. Returns only messages the user bookmarked in that channel. Omit both to_channel and to_contact to list bookmarks across all conversations.
string
Optional 1:1 contact filter, given as an email address, user ID, or member ID. Returns only messages the user bookmarked in the 1:1 conversation with that contact. Omit both to_channel and to_contact to list bookmarks across all conversations.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_CHANNEL_MEMBERSList the members of a Zoom Team Chat channel.

Input Parameters

integer
Number of records per page (max 100).
string
required
The channel ID.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_CHANNELSList the Zoom Team Chat channels the authenticated user is a member of.

Input Parameters

integer
Number of records per page (max 1000).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_CONTACTSList the authenticated user’s Zoom Team Chat contacts, with company contacts returned by default or external contacts selected by type. External contacts may have an empty user ID; their member ID can identify them for 1:1 messaging.

Input Parameters

string ("company" | "external")
Contact type filter: ‘company’ for contacts from the user’s own organization, ‘external’ for external contacts. Omitting this does NOT return all contacts — Zoom defaults to ‘company’.
integer
Number of records per page (max 50).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_MESSAGESList Zoom Team Chat messages and shared files in a channel or 1:1 conversation, or search messages or files across conversations. Results default to today when no date or start time is provided.

Input Parameters

string
Day to query, in yyyy-MM-dd format. Defaults to today when omitted. If both date and from are supplied, Zoom uses date. The queried date is echoed back in the response.
string
End of the query window, in yyyy-MM-ddTHH:mm:ssZ format. Defaults to the current date.
string
Start of the query window, in yyyy-MM-ddTHH:mm:ssZ format. Ignored when date is also provided.
integer
Number of records per page (max 50).
string
Search text (1-256 characters). Must be provided with search_type.
string
Channel ID of the channel whose messages to retrieve. Returns messages the user sent and received in that channel. Provide EXACTLY ONE of to_channel or to_contact.
string
Email address, user ID, or member ID of the 1:1 chat contact. Returns messages exchanged directly between the user and this contact. Provide EXACTLY ONE of to_channel or to_contact.
string ("message" | "file")
Search messages or files. Must be provided together with search_key.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.
string
Return audio-file download URLs in MP4 format when set to ‘audio/mp4’.
boolean
Exclude thread replies and return parent messages only.
boolean
Include normal, edited, and deleted messages when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_PINNED_MESSAGESList the pinned messages of a Zoom Team Chat channel. Set include_history to also return previously-pinned (now unpinned) history messages.

Input Parameters

integer
Number of records per page (max 50). Zoom defaults to 10 when omitted.
string
required
Channel ID of the Zoom Team Chat channel whose pinned messages to list.
boolean
When true, the result also includes previously-pinned (now unpinned) history messages, not just the currently-pinned ones. Defaults to false.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_REMINDERSList the authenticated user’s Zoom Team Chat message reminders. Optionally filter by a channel (to_channel) or a 1:1 contact (to_contact); omit both to list all reminders.

Input Parameters

integer
Number of records per page (1-20). Zoom defaults to 10.
string
The ID of the Zoom channel whose reminders to query. If neither to_channel nor to_contact is passed, all reminders in channels and 1:1 chats are returned.
string
The email address of the Zoom contact whose 1:1 chat reminders to query. If neither to_channel nor to_contact is passed, all reminders in channels and 1:1 chats are returned.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_SCHEDULED_MESSAGESList the user’s scheduled (draft) Zoom Team Chat messages queued to send to a channel or a 1:1 contact. Provide exactly one of to_channel or to_contact.

Input Parameters

integer
Number of records per page (max 50). Zoom defaults to 10 when omitted.
string
Channel ID of the channel the scheduled (draft) messages belong to. Returns drafts queued to send to that channel. Provide EXACTLY ONE of to_channel or to_contact.
string
Email address, user ID, or member ID of the 1:1 chat contact the scheduled (draft) messages are addressed to. Provide EXACTLY ONE of to_channel or to_contact.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_SESSIONSList the authenticated user’s Zoom Team Chat sessions, including group chats and 1:1 conversations, within a time window that defaults to today. Alternatively, list starred sessions without a time window.

Input Parameters

string ("1:1" | "groupchat")
Filter sessions by chat type. Use ‘1:1’ for direct conversations or ‘groupchat’ for channels. Omit to return both. Allowed when search_star is true, but the from_time / to_time window is not.
string
End of the query window, in yyyy-MM-ddTHH:mm:ssZ format. Defaults to the end of today. Not allowed together with search_star.
string
Start of the query window, in yyyy-MM-ddTHH:mm:ssZ format. Defaults to the start of today. Not allowed together with search_star.
integer
Number of records per page (max 50).
boolean
When true, return only starred sessions. When true, the from_time / to_time window is not allowed (Zoom returns HTTP 400).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_SHARED_SPACE_CHANNELSList the channels grouped inside a Zoom Team Chat shared space.

Input Parameters

string
required
The shared space ID (from LIST_SHARED_SPACES or CREATE_SHARED_SPACE) whose channels to list.
integer
Number of records per page (max 50).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_SHARED_SPACE_MEMBERSList the members and administrators of a Zoom Team Chat shared space.

Input Parameters

string ("all" | "member" | "admin" | "owner")
Filter members by role: all (default), member, admin, or owner.
string ("all" | "active" | "inactive")
Filter members by status: all (default), active, or inactive.
string
required
The shared space ID.
integer
Number of records per page (max 50).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_LIST_SHARED_SPACESList the Zoom Team Chat shared spaces the authenticated user belongs to.

Input Parameters

integer
Number of records per page (max 50).
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_MARK_MESSAGE_READMark a Zoom Team Chat message as read or unread. Identify the message by message_id plus the conversation it lives in: provide exactly one of to_channel (a channel message) or to_contact (a 1:1 message). Set action to ‘read’ (default) or ‘unread’. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string ("read" | "unread")
Whether to mark the message as ‘read’ or ‘unread’.
integer
Timestamp in epoch milliseconds of the message to mark.
string
required
The message ID to mark as read or unread.
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the 1:1 chat contact the message belongs to. Exactly one of to_channel or to_contact is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_MOVE_SHARED_SPACE_CHANNELSMove existing Zoom Team Chat channels into or out of a shared space. Returns per-channel results; success requires every channel to report is_moved=true.

Input Parameters

string
required
The shared space’s unique identifier ID.
array
required
Unique IDs of the channels to move into or out of the shared space.
string ("move_into" | "move_out")
required
Direction to move the channels: ‘move_into’ the shared space or ‘move_out’ of it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_PIN_MESSAGEPin or unpin a message in a Zoom Team Chat channel. Set action to ‘pin’ or ‘unpin’, and identify the message by message_id plus the channel_id it belongs to. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string ("pin" | "unpin")
required
Whether to pin or unpin the message.
string
required
ID of the channel the message belongs to.
string
required
The message ID to pin or unpin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_REACT_TO_MESSAGEAdd or remove an emoji reaction on a Zoom Team Chat message. Identify the message by message_id plus the conversation it lives in: provide exactly one of to_channel (a channel message) or to_contact (a 1:1 message). The emoji is a Unicode codepoint string without a ‘U+’ prefix (e.g. ‘1F44D’). Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string
Unicode codepoint of the emoji WITHOUT a ‘U+’ prefix, e.g. ‘1F44D’ for thumbs-up.
string ("add" | "remove")
Whether to add or remove the reaction.
string
required
The message ID to react to.
string
Channel ID of the channel the message belongs to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the 1:1 chat contact the message belongs to. Exactly one of to_channel or to_contact is required.
boolean
Set true to react with the custom emoji identified by custom_emoji_id.
string
Custom emoji file ID. Required when custom_emoji is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_REMOVE_CHANNEL_MEMBERRemove a single member from a Zoom Team Chat channel. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body. Removing someone who is not a member of the channel fails with a 404 (code 1001).

Input Parameters

string
required
The channel ID.
string
required
Email address, user ID, or member ID of the member to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_REMOVE_SHARED_SPACE_MEMBERSRemove members or administrators from a Zoom Team Chat shared space by user ID or member ID (the shared space owner cannot be removed). Zoom processes each identifier independently and returns HTTP 200 even when every removal fails, so success must be judged from successful_operations_count / unsuccessful_operations_count and each entry’s operation_status - not the HTTP status.

Input Parameters

string
required
Unique ID of the shared space to remove members from.
array
required
User IDs or member IDs of the members or administrators to remove from the shared space (max 20). The shared space owner cannot be removed. Removal is processed per identifier - inspect each entry’s operation_status in the response to see which removals succeeded, since Zoom returns HTTP 200 even when some or all removals fail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_SEARCH_CHANNELSSearch Zoom Team Chat channels by fuzzy keywords or exact name among joined channels, account public channels, or all account channels where permitted. Returns one page of matches; joined-channel searches return at most one page.

Input Parameters

string ("user_joined" | "public" | "all")
Where to search: ‘user_joined’ (channels the user is a member of) or ‘public’ (public channels in the org). ‘all’ requires an account admin role and fails with 400 ‘No permission’ for regular users.
array
Fuzzy-match keywords to search channel names by. Alphanumeric/unicode characters only — Zoom rejects whitespace and symbols inside a keyword. Provide keywords OR channel_name, not both.
integer
Number of channels per page (max 20).
string
Exact channel name to match. Provide channel_name OR keywords, not both.
string
Continuation cursor from a previous page’s next_page_token. Omit for the first page; pass the other search parameters again unchanged.
boolean
Include archived channels in the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_SEARCH_COMPANY_CONTACTSSearch the connected user’s organization directory for contacts by keyword (first name, last name, or email address). Optionally include each contact’s presence status.

Input Parameters

integer
Number of records to return per page (1-25). The tool defaults to 25 for useful directory searches; Zoom’s own server default is 1.
string
required
Keyword to search the organization’s directory by: a contact’s first name, last name, or email address. Required.
string ("active" | "inactive")
Zoom user status filter. Only applies to contact type 1.
integer ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8")
Contact type to search: 1 = Zoom user, 2 = auto receptionist, 3 = common area phone, 4 = call queue, 5 = shared line group, 6 = shared global directory, 7 = shared office contact, 8 = Zoom Room. Some phone contact types require a Zoom Phone management role with View permission.
string
Continuation token from a previous call’s next_page_token. Omit to fetch the first page. Zoom tokens expire after 15 minutes.
boolean
Set true to include each matching contact’s presence status (e.g. Available, Away) in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_SEND_MESSAGESend a Zoom Team Chat message to a channel or a 1:1 contact, optionally as a thread reply (reply_main_message_id) or scheduled for later (scheduled_time). Exactly one of to_channel or to_contact must be provided.

Input Parameters

string
required
The message text to send.
array
Mention metadata whose positions refer to the message string.
array
File IDs to attach to the message (maximum six).
array
Rich-text formatting ranges for the message.
string
Channel ID to send the message to. Exactly one of to_channel or to_contact is required.
string
Email address, user ID, or member ID of the contact for a 1:1 message. Exactly one of to_channel or to_contact is required.
string
Optional UTC timestamp in yyyy-MM-ddTHH:mm:ssZ format to schedule the message instead of sending it immediately. Zoom requires it to be more than 30 minutes from now and no more than 180 days away. Scheduled drafts appear in LIST_SCHEDULED_MESSAGES.
array
Interactive cards to send (maximum five).
string
Message ID of a parent message; when set, this message is posted as a reply inside that message’s thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_STAR_CONVERSATIONStar or unstar a Zoom Team Chat channel or contact for the authenticated user. Set target_type to ‘channel’ or ‘contact’ and target_id to the channel ID, contact user ID, or contact member ID. Returns {success: true} on success; the underlying API responds with HTTP 204 and an empty body.

Input Parameters

string ("star" | "unstar")
required
Whether to star or unstar the target.
string
required
Channel ID, contact user ID, or contact member ID to star or unstar.
string ("channel" | "contact")
required
Type of the target: ‘channel’ or ‘contact’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_UPDATE_CHANNELRename a Zoom Team Chat channel or update its type/settings.

Input Parameters

string
New display name for the channel.
integer ("1" | "2" | "3" | "5")
New channel type: 1, 2, 3, or 5 (see Zoom channel type documentation for the meaning of each value).
string
required
The ID of the channel to update.
object
Channel settings to change (add-member permissions, posting permissions, @all mention permissions, …). Only the provided settings are modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_UPDATE_MESSAGEUpdate a Zoom Team Chat message previously sent by the connected user, including its text, attached file IDs or interactive cards. Identify the channel or 1:1 contact containing the message.

Input Parameters

string
New message text. Omit when updating only files or interactive cards.
array
File IDs to retain or add (maximum six); an empty list clears files.
string
required
The ID of the message to edit.
string
Channel ID the message was sent to. Exactly one of to_channel or to_contact is required. Sent in the request body on this endpoint.
string
Contact (email, user ID, or member ID) the message was sent to for a 1:1 chat. Exactly one of to_channel or to_contact is required. Sent in the request body on this endpoint.
array
Interactive cards to retain or replace (maximum five); an empty list clears cards. card_id takes precedence over card_json.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOOM_CHAT_UPDATE_SHARED_SPACEUpdate a Zoom Team Chat shared space’s name, description, or settings.

Input Parameters

string
required
The ID of the shared space to update.
string
New description for the shared space.
string
New name for the shared space.
object
Settings to change (external-user, add-member and create-channel permissions). Only the provided settings are modified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not