> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Sendbird

> Sendbird is a platform that provides chat, voice, and video APIs to help businesses build in-app communication features.

![Sendbird logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/sendbird.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=ca7cfce1f447c50a3c25008c1843e0e5)

* **Category:** communication
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 37
* **Triggers:** 0
* **Slug:** `SENDBIRD`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Members To Group Channel
>
> **Slug:** `SENDBIRD_ADD_MEMBERS_GROUP_CHANNEL`
>
> Tool to add members to a group channel. Use when you need to invite one or more users into an existing group channel.
>
> #### Input Parameters
>
> **seconds** `integer`
>
> Duration in seconds to hide previous messages. Required if hide\_existing\_messages is true.
>
> **user\_ids** `array` *required*
>
> List of User IDs to add to the channel.
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the target group channel.
>
> **hide\_existing\_messages** `boolean`
>
> Whether to hide previous messages for new members.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ban User from Group Channel
>
> **Slug:** `SENDBIRD_BAN_USER_FROM_GROUP_CHANNEL`
>
> Tool to ban a user from a group channel. Use when moderating group channels to restrict member access. Execute after confirming channel\_url and user\_id.
>
> #### Input Parameters
>
> **seconds** `integer`
>
> Duration of the ban in seconds. If omitted, ban is permanent.
>
> **user\_id** `string` *required*
>
> ID of the user to ban from the channel.
>
> **agent\_id** `string`
>
> ID of the admin or moderator performing the ban.
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel to ban the user from.
>
> **description** `string`
>
> Reason for the ban in moderation records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Group Channel
>
> **Slug:** `SENDBIRD_CREATE_CHANNEL`
>
> Tool to create a new group channel. Use when you need to start a conversation with specific users. Execute after specifying users and optional settings.
>
> #### Input Parameters
>
> **data** `string`
>
> Custom data for the channel
>
> **name** `string`
>
> Name of the channel
>
> **strict** `boolean`
>
> True for strict creation; fails if channel exists
>
> **is\_super** `boolean`
>
> True to create a supergroup channel
>
> **user\_ids** `array`
>
> List of user IDs to invite to the channel (max 100)
>
> **cover\_url** `string`
>
> URL of the channel cover image
>
> **is\_public** `boolean`
>
> True to create a public channel
>
> **cover\_file** `string`
>
> Binary content of the cover image for multipart upload
>
> **access\_code** `string`
>
> Access code for private channels
>
> **channel\_url** `string`
>
> Custom URL of the channel; autogenerated if omitted
>
> **custom\_type** `string`
>
> Custom type identifier for the channel
>
> **is\_distinct** `boolean`
>
> True to create a distinct channel
>
> **is\_ephemeral** `boolean`
>
> True to create an ephemeral channel
>
> **operator\_ids** `array`
>
> List of user IDs to assign as operators
>
> **custom\_fields** `object`
>
> Custom fields object
>
> **is\_discoverable** `boolean`
>
> True to list the channel in search results
>
> **is\_chat\_notification** `boolean`
>
> True to send system notifications for channel events
>
> **message\_survival\_seconds** `integer`
>
> Message retention period in seconds
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Sendbird User
>
> **Slug:** `SENDBIRD_CREATE_USER`
>
> Creates a new user in Sendbird. Use this to register user accounts before they can join channels or send messages. The user\_id must be unique across the application.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique identifier for the new user. Must be unique across the application. Can contain alphanumeric characters, underscores, and hyphens.
>
> **metadata** `object`
>
> Custom key-value pairs to store additional user data. Keys and values must be strings.
>
> **nickname** `string`
>
> Display name shown to other users in channels. If not provided, may default to user\_id.
>
> **is\_active** `boolean`
>
> If true, the user is active and can send/receive messages. Inactive users cannot participate in channels.
>
> **profile\_url** `string`
>
> URL of the user's profile image. Must be a valid HTTP/HTTPS URL.
>
> **phone\_number** `string`
>
> User's phone number in E.164 format (e.g., +15551234567). Used for user discovery if enabled.
>
> **profile\_file** `string`
>
> Binary content of the user's profile image for multipart upload. Use this instead of profile\_url when uploading an image file directly.
>
> **discovery\_keys** `array`
>
> List of unique keys used to find this user through the discovery feature (e.g., email addresses, phone numbers).
>
> **has\_ever\_logged\_in** `boolean`
>
> Internal flag indicating if the user has ever logged in. Typically managed by the system.
>
> **issue\_access\_token** `boolean`
>
> If true, generates and returns an access token for the user that can be used for client-side authentication.
>
> **preferred\_languages** `array`
>
> List of ISO 639-1 language codes indicating user's preferred languages for push notifications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Group Channel
>
> **Slug:** `SENDBIRD_DELETE_CHANNEL`
>
> Permanently deletes a Sendbird group channel. Use this tool when you need to remove a group channel and all its associated data (messages, members, etc.). WARNING: This action is irreversible. Requires the channel\_url identifier of the channel to delete.
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> The unique URL identifier of the group channel to delete. This is the channel's unique ID, typically in format like 'sendbird\_group\_channel\_123456' or a custom URL set during channel creation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Message
>
> **Slug:** `SENDBIRD_DELETE_MESSAGE`
>
> Permanently deletes a specific message from a Sendbird group channel. This action cannot be undone. Use this when you need to remove a message that was sent by mistake or contains inappropriate content. Requires both channel\_url and message\_id, which can be obtained from channel/message listing endpoints.
>
> #### Input Parameters
>
> **message\_id** `integer` *required*
>
> Unique numeric ID of the message to delete. Must be a positive integer obtained from message listing or message sending responses.
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel containing the message to delete. Can be obtained from channel creation responses or channel listing endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Sendbird User
>
> **Slug:** `SENDBIRD_DELETE_USER`
>
> Tool to delete a Sendbird user. Use when you need to remove a user from your Sendbird application, optionally permanently.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user to delete.
>
> **hard\_delete** `boolean`
>
> Whether to permanently delete the user and all associated data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Count Preference Of Channel
>
> **Slug:** `SENDBIRD_GET_COUNT_PREFERENCE_OF_CHANNEL`
>
> Tool to retrieve a user's count preference for a specific group channel. Use after confirming the user and channel exist to determine whether to display all, unread-only, or mention-only counts.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique ID of the user.
>
> **channel\_url** `string` *required*
>
> URL (identifier) of the group channel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Group Channel Count by Join Status
>
> **Slug:** `SENDBIRD_GET_NUMBER_OF_CHANNELS_BY_JOIN_STATUS`
>
> Retrieves a user's group-channel counts by join status. Optionally filter the counts by channel visibility, distinctness, super mode, or custom channel type.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique ID of the target user whose group channel count will be retrieved.
>
> **super\_mode** `string ("all" | "super" | "nonsuper")`
>
> Filter by channel type. 'super' channels support up to tens of thousands of members; 'nonsuper' regular channels support up to 100 members. Defaults to 'all'.
>
> **public\_mode** `string ("all" | "public" | "private")`
>
> Filter by channel visibility. 'public' channels allow users to join without invitation; 'private' channels require an invitation. Defaults to 'all'.
>
> **custom\_types** `array`
>
> Filter by custom channel types. Only channels matching one of the specified custom types will be counted. Pass an empty list or omit to include all custom types.
>
> **distinct\_mode** `string ("all" | "distinct" | "nondistinct")`
>
> Filter by channel distinctness. 'distinct' channels resume conversations with the same members; 'nondistinct' allows multiple channels with identical member sets. Defaults to 'all'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sendbird Get Unread Item Count
>
> **Slug:** `SENDBIRD_GET_NUMBER_OF_UNREAD_ITEMS`
>
> Tool to retrieve a user's unread item counts including unread messages, mentions, and pending invitations across group channels. Use this to display unread counts in the UI for a specific user.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user whose unread item counts are to be retrieved.
>
> **item\_keys** `string`
>
> Comma-separated list of item keys to retrieve. Options: non\_super\_group\_channel\_unread\_message\_count, super\_group\_channel\_unread\_message\_count, group\_channel\_unread\_message\_count, non\_super\_group\_channel\_unread\_mention\_count, super\_group\_channel\_unread\_mention\_count, group\_channel\_unread\_mention\_count, non\_super\_group\_channel\_invitation\_count, super\_group\_channel\_invitation\_count, group\_channel\_invitation\_count. If not specified, returns all available counts.
>
> **custom\_types** `string`
>
> Comma-separated list of custom channel types to filter the count by.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Issue Session Token
>
> **Slug:** `SENDBIRD_ISSUE_SESSION_TOKEN`
>
> Issues a session token for authenticating a Sendbird user. Use this tool when you need to: - Generate a new session token for SDK authentication - Refresh an expiring or expired session token - Provide secure access for a user to connect to Sendbird chat The session token has a default expiration of 7 days if expires\_at is not specified.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique ID of the user to issue a session token for.
>
> **expires\_at** `integer`
>
> Optional token expiration timestamp in Unix milliseconds. If omitted, the default token lifetime is used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Leave Group Channels
>
> **Slug:** `SENDBIRD_LEAVE_GROUP_CHANNELS`
>
> Tool to leave group channels for a user. Use when you need to make a user exit one or more joined group channels.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user who will leave group channels.
>
> **custom\_type** `string`
>
> Custom type to filter which group channels to leave. Only channels with this custom type will be left.
>
> **channel\_urls** `array`
>
> List of group channel URLs to leave. Required unless `should_leave_all` is true or `custom_type` is specified.
>
> **should\_leave\_all** `boolean`
>
> Whether to leave all joined group channels. If true, `channel_urls` is ignored.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Banned Members
>
> **Slug:** `SENDBIRD_LIST_BANNED_MEMBERS`
>
> Tool to list banned members in a group channel. Use when you need to see which users are banned from a specific group channel.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of banned members to return per page (1-100). Default is 10.
>
> **token** `string`
>
> Pagination token from previous response; omit for first request.
>
> **channel\_url** `string` *required*
>
> Unique URL of the group channel to list banned members from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sendbird List Group Channel Messages
>
> **Slug:** `SENDBIRD_LIST_GROUP_CHANNEL_MESSAGES`
>
> Tool to list (paginate) messages in a group channel when you only know the channel\_url. Requires either message\_ts (Unix ms timestamp) or message\_id as an anchor. Use with SENDBIRD\_VIEW\_GROUP\_CHANNEL (show\_read\_receipt=true) to fetch unread messages: get last-read timestamp, then call this with message\_ts=\<last\_read>, prev\_limit=0, next\_limit=\<batch\_size>, include=false.
>
> #### Input Parameters
>
> **include** `boolean`
>
> Whether to include the anchor message in the results. Default is false.
>
> **reverse** `boolean`
>
> Whether to reverse the order of results. Default is false.
>
> **sender\_id** `string`
>
> Filter messages by a single sender's user ID.
>
> **message\_id** `integer`
>
> Message ID anchor. Use to fetch messages around this message. Required if message\_ts is not provided.
>
> **message\_ts** `integer`
>
> Timestamp anchor in Unix milliseconds. Use to fetch messages around this time. Required if message\_id is not provided.
>
> **next\_limit** `integer`
>
> Number of messages to retrieve after the anchor (0-200). Default is 10.
>
> **prev\_limit** `integer`
>
> Number of messages to retrieve before the anchor (0-200). Default is 0.
>
> **sender\_ids** `string`
>
> Filter messages by multiple sender user IDs (comma-separated).
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel.
>
> **custom\_types** `string`
>
> Filter by custom message types (comma-separated).
>
> **message\_type** `string`
>
> Filter by message type. Options: MESG (text), FILE (file), ADMM (admin). Can combine with commas.
>
> **operator\_filter** `string`
>
> Filter by operator status. Options: all, operator, nonoperator.
>
> **include\_reactions** `boolean`
>
> Whether to include reaction information. Default is false.
>
> **including\_removed** `boolean`
>
> Whether to include removed messages. Default is false.
>
> **include\_reply\_type** `string`
>
> Filter by reply type. Options: all, only\_reply\_to\_channel, none.
>
> **include\_thread\_info** `boolean`
>
> Whether to include thread information. Default is false.
>
> **include\_poll\_details** `boolean`
>
> Whether to include poll details for messages with polls. Default is false.
>
> **with\_sorted\_meta\_array** `boolean`
>
> Whether to include sorted metadata arrays. Default is false.
>
> **include\_parent\_message\_info** `boolean`
>
> Whether to include parent message information for threaded messages. Default is false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Group Channels
>
> **Slug:** `SENDBIRD_LIST_GROUP_CHANNELS`
>
> Tool to list group channels. Use when you need to fetch paginated group channels with optional filters.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter channels by channel name
>
> **limit** `integer`
>
> Number of results per page (1-100)
>
> **token** `string`
>
> Pagination token to retrieve the next page
>
> **show\_empty** `boolean`
>
> Whether to include empty channels in the results
>
> **super\_mode** `string ("all" | "super" | "nonsuper")`
>
> Filter by super channel type: all, super, or nonsuper
>
> **public\_mode** `string ("all" | "public" | "private")`
>
> Filter by public channel type: all, public, or private
>
> **show\_frozen** `boolean`
>
> Whether to include frozen channels in the results
>
> **channel\_urls** `array`
>
> Filter channels by exact URLs
>
> **custom\_types** `array`
>
> Filter channels by custom types
>
> **url\_contains** `string`
>
> Filter channels whose URL contains this substring
>
> **created\_after** `integer`
>
> List channels created after this timestamp (in milliseconds)
>
> **distinct\_mode** `string ("all" | "distinct" | "nondistinct")`
>
> Filter by distinct channel type: all, distinct, or nondistinct
>
> **show\_metadata** `boolean`
>
> Whether to include channel metadata
>
> **created\_before** `integer`
>
> List channels created before this timestamp (in milliseconds)
>
> **my\_member\_state** `string ("all" | "joined_only" | "invited_only" | "invited_by_friend" | "invited_by_non_friend")`
>
> Filter by member state: all, joined\_only, invited\_only, invited\_by\_friend, or invited\_by\_non\_friend
>
> **members\_nickname** `string`
>
> Filter channels by member nickname
>
> **show\_read\_receipt** `boolean`
>
> Whether to include read receipt data
>
> **members\_exactly\_in** `array`
>
> List of user IDs who must all be members of the channel
>
> **members\_include\_in** `array`
>
> List of user IDs one of whom must be a member of the channel
>
> **show\_delivery\_receipt** `boolean`
>
> Whether to include delivery receipt data
>
> **custom\_type\_startswith** `string`
>
> Filter channels whose custom type starts with this prefix
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Group Channel Members
>
> **Slug:** `SENDBIRD_LIST_MEMBERS_GROUP_CHANNEL`
>
> Tool to list members of a group channel. Use when you need to paginate through members of a specified group channel.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (1-100)
>
> **order** `string ("nickname_alphabetical" | "operator_alphabetical")`
>
> Sorting order of members list
>
> **token** `string`
>
> Pagination token for fetching the next page
>
> **offset** `integer`
>
> Number of results to skip before returning the set (deprecated; use token instead)
>
> **channel\_url** `string` *required*
>
> Unique URL of the group channel
>
> **operator\_filter** `string ("all" | "operator" | "nonoperator")`
>
> Filter by operator status
>
> **member\_state\_filter** `string ("all" | "joined_only" | "invited_only")`
>
> Filter by membership state
>
> **muted\_member\_filter** `string ("all" | "muted" | "unmuted")`
>
> Filter by muted status of members
>
> **nickname\_startswith** `string`
>
> Search members whose nicknames start with this string
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Operators by Custom Channel Type
>
> **Slug:** `SENDBIRD_LIST_OPERATORS_CUSTOM_CHANNEL_TYPE`
>
> Tool to list operators of a channel by custom channel type. Use when you need to fetch operators for a specific custom channel type with pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of operators to return per page (1-100).
>
> **token** `string`
>
> Pagination cursor from a previous call; omit for the first request.
>
> **custom\_type** `string` *required*
>
> Custom channel type to list operators for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Group Channel Operators
>
> **Slug:** `SENDBIRD_LIST_OPERATORS_GROUP_CHANNEL`
>
> Tool to list operators of a group channel. Use after specifying the channel\_url when needing to paginate through operators.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of operators to return per page (1-100). Default is 10.
>
> **token** `string`
>
> Pagination token from previous response; omit for first page
>
> **channel\_url** `string` *required*
>
> URL of the group channel to retrieve operators from
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Open Channel Operators
>
> **Slug:** `SENDBIRD_LIST_OPERATORS_OPEN_CHANNEL`
>
> Tool to list operators of an open channel. Use when you have the open channel URL and need to fetch its operators. Supports pagination via token and limit.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of operators to return per page (1-100).
>
> **token** `string`
>
> Pagination cursor from a previous response; omit for the first request.
>
> **channel\_url** `string` *required*
>
> URL-encoded unique identifier of the open channel to list operators for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sendbird Users
>
> **Slug:** `SENDBIRD_LIST_USERS`
>
> Retrieves a paginated list of users from your Sendbird application. Use this tool to: - Browse all users in your application - Search for users by nickname or user IDs - Filter users by metadata, custom type, or activity status - Paginate through large user lists using the 'next' token Returns user details including profile info, connection status, and metadata. Results are paginated; use the 'next' token from the response to fetch additional pages.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of users to return per page (1-100). Defaults to 10 if not specified.
>
> **order** `string ("nickname_alphabetical" | "created_at" | "user_id_alphabetical")`
>
> Sort order for results. Options: 'nickname\_alphabetical' (A-Z by nickname), 'created\_at' (newest first), 'user\_id\_alphabetical' (A-Z by user ID).
>
> **token** `string`
>
> Pagination token from the 'next' field of a previous response. Omit for the first page.
>
> **nickname** `string`
>
> Filter users by exact nickname match (case-insensitive).
>
> **user\_ids** `array`
>
> Filter to only return specific users by their IDs. Provide as a list of user ID strings.
>
> **is\_active** `boolean`
>
> Filter by account status. Set to true for active users, false for deactivated users.
>
> **custom\_type** `string`
>
> Filter users by their custom type classification.
>
> **metatag\_key** `string`
>
> Filter users who have this metadata key set. Use with metatag\_values for key-value filtering.
>
> **metatag\_values** `array`
>
> Filter users by metadata values for the specified metatag\_key. Requires metatag\_key to be set.
>
> **nickname\_contains** `string`
>
> Filter users whose nickname contains this substring (case-insensitive partial match).
>
> **has\_ever\_logged\_in** `boolean`
>
> Filter by login history. Set to true for users who have logged in, false for never logged in.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark All User Messages As Read
>
> **Slug:** `SENDBIRD_MARK_ALL_USER_MESSAGES_AS_READ`
>
> Tool to mark all of a user's messages as read in group channels. Use when resetting unread message counts after a user has viewed all messages.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user whose messages will be marked as read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mute User
>
> **Slug:** `SENDBIRD_MUTE_USER`
>
> Tool to mute a user in a group channel. Use when you need to prevent a user from sending messages for a specified duration.
>
> #### Input Parameters
>
> **seconds** `integer`
>
> Mute duration in seconds (0 = indefinite)
>
> **user\_id** `string` *required*
>
> ID of the user to mute
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the target group channel
>
> **description** `string`
>
> Custom description for the mute action
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Register Operators by Custom Channel Type
>
> **Slug:** `SENDBIRD_REGISTER_OPERATORS_CUSTOM_CHANNEL_TYPE`
>
> Registers one or more users as operators for all channels with a specified custom channel type. Use this tool when you need to grant operator privileges to users across all channels that share the same custom\_type. Operators have elevated permissions including: - Muting and banning users from channels - Deleting messages in channels - Freezing/unfreezing channels - Managing channel settings Prerequisites: - The user IDs must belong to existing Sendbird users - The custom\_type should match channels you want to manage Note: This affects all channels with the specified custom\_type, not just a single channel.
>
> #### Input Parameters
>
> **custom\_type** `string` *required*
>
> The custom channel type identifier. This assigns operator privileges to specified users for all channels that have this custom type. The custom\_type must match an existing channel's custom\_type value.
>
> **operator\_ids** `array` *required*
>
> List of existing Sendbird user IDs to register as operators. At least one user ID is required. Operators have elevated privileges like muting/banning users, deleting messages, and managing channel settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Register Group Channel Operators
>
> **Slug:** `SENDBIRD_REGISTER_OPERATORS_GROUP_CHANNEL`
>
> Tool to register one or more users as operators in a Sendbird group channel. Use when elevating permissions of existing channel members.
>
> #### Input Parameters
>
> **user\_ids** `array` *required*
>
> List of user IDs to register as operators
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Register Operators to Open Channel
>
> **Slug:** `SENDBIRD_REGISTER_OPERATORS_OPEN_CHANNEL`
>
> Tool to register operators to an open channel. Use after creating or updating an open channel when you need to assign operator roles.
>
> #### Input Parameters
>
> **user\_ids** `array` *required*
>
> List of user IDs to register as operators (at least one)
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the open channel
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke All Session Tokens
>
> **Slug:** `SENDBIRD_REVOKE_ALL_SESSION_TOKENS`
>
> Tool to revoke all session tokens for a user. Use when you need to invalidate all active sessions for security.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user whose session tokens will be revoked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message
>
> **Slug:** `SENDBIRD_SEND_MESSAGE`
>
> Sends a text or admin message request to a group channel. It also accepts the FILE message type, but provides no file upload or file URL parameter.
>
> #### Input Parameters
>
> **data** `string`
>
> Free-form custom data string (often JSON)
>
> **message** `string`
>
> Text content of the message. Required when message\_type is 'MESG'
>
> **poll\_id** `integer`
>
> Attach an existing poll by its ID
>
> **user\_id** `string`
>
> Sender's user ID. Required unless using API token as acting user
>
> **is\_silent** `boolean`
>
> Send as silent message (no push notifications)
>
> **metaarray** `array`
>
> Array of metadata objects
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the target group channel
>
> **custom\_type** `string`
>
> Custom message type for classification
>
> **mention\_type** `string ("users" | "channel")`
>
> Mention scope: 'users' to mention specific users or 'channel' to mention all
>
> **message\_type** `string ("MESG" | "FILE" | "ADMM")` *required*
>
> Type of message: 'MESG' for text, 'FILE' for file, 'ADMM' for admin message
>
> **parent\_message\_id** `integer`
>
> Reply in a thread to the message with this ID
>
> **mentioned\_user\_ids** `array`
>
> List of user IDs to mention when mention\_type is 'users'
>
> **is\_operator\_message** `boolean`
>
> Mark as operator (moderator) message
>
> **translation\_target\_languages** `array`
>
> List of language codes for auto-translation, e.g., \['en', 'es']
>
> **push\_notification\_delivery\_option** `string ("default" | "suppress" | "include_offline_user")`
>
> Push notification option: 'default', 'suppress', or 'include\_offline\_user'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unban User from Group Channel
>
> **Slug:** `SENDBIRD_UNBAN_USER`
>
> Tool to unban a user from a group channel. Use when reinstating a previously banned user. Execute after confirming the user is currently banned.
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> The URL of the group channel from which to unban the user.
>
> **banned\_user\_id** `string` *required*
>
> The unique ID of the banned user to unban.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unmute User
>
> **Slug:** `SENDBIRD_UNMUTE_USER`
>
> Tool to unmute a user in a group channel. Use when you want to restore a muted user's ability to send messages after confirming they are muted.
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel to unmute the user in.
>
> **muted\_user\_id** `string` *required*
>
> User ID to unmute from the channel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unregister Operators Custom Channel Type
>
> **Slug:** `SENDBIRD_UNREGISTER_OPERATORS_CUSTOM_CHANNEL_TYPE`
>
> Tool to unregister operators from channels by custom channel type. Use when you need to remove operator roles from users across channels of a specific custom type.
>
> #### Input Parameters
>
> **user\_ids** `array` *required*
>
> List of user IDs to unregister as operators.
>
> **custom\_type** `string` *required*
>
> Custom channel type to target. Example: 'my\_custom\_type'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Count Preference Of Channel
>
> **Slug:** `SENDBIRD_UPDATE_COUNT_PREFERENCE_OF_CHANNEL`
>
> Tool to update a user's unread count preference for a specific group channel. Use when you want to include or suppress a channel in the user's unread counts.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique ID of the user.
>
> **channel\_url** `string` *required*
>
> URL identifier of the group channel.
>
> **count\_preference** `string ("all" | "unread_message_count_only" | "mention_count_only" | "none")` *required*
>
> The user's count preference for the channel: one of 'all', 'unread\_message\_count\_only', 'mention\_count\_only', or 'none'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Group Channel
>
> **Slug:** `SENDBIRD_UPDATE_GROUP_CHANNEL`
>
> Tool to update group channel information. Use when you need to modify channel attributes such as name, cover image, privacy settings, or operator list after channel creation.
>
> #### Input Parameters
>
> **data** `string`
>
> Custom channel data as a JSON-encoded string
>
> **name** `string`
>
> New name for the channel
>
> **is\_super** `boolean`
>
> Whether this is a supergroup channel
>
> **cover\_url** `string`
>
> HTTPS URL for the channel's cover image
>
> **is\_public** `boolean`
>
> Whether this channel is publicly joinable
>
> **operators** `array`
>
> List of user IDs to assign as channel operators
>
> **access\_code** `string`
>
> Access code required for joining this channel
>
> **channel\_url** `string` *required*
>
> URL identifier of the group channel to update
>
> **custom\_type** `string`
>
> Custom type label for the channel
>
> **is\_distinct** `boolean`
>
> Whether this is a distinct channel
>
> **is\_ephemeral** `boolean`
>
> Whether this channel is ephemeral
>
> **my\_count\_preference** `string ("unread_message_count_only" | "all_count")`
>
> Unread count preference ("unread\_message\_count\_only" or "all\_count")
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sendbird Update Message
>
> **Slug:** `SENDBIRD_UPDATE_MESSAGE`
>
> Tool to update an existing group channel message in Sendbird. Use after you need to modify content or metadata of a sent message.
>
> #### Input Parameters
>
> **data** `string`
>
> Additional data for the message as a JSON-encoded string
>
> **content** `string`
>
> New text content of the message
>
> **user\_id** `string`
>
> ID of the user performing the update
>
> **dedup\_id** `string`
>
> Deduplication ID for the message update
>
> **is\_silent** `boolean`
>
> Whether the message update should be silent (no push notification)
>
> **message\_id** `string` *required*
>
> Unique ID of the message to update
>
> **channel\_url** `string` *required*
>
> URL identifier of the group channel containing the message
>
> **custom\_type** `string`
>
> Custom type label for the message
>
> **mention\_type** `string`
>
> Mention type for the message (e.g., 'users' or 'channel')
>
> **message\_type** `string`
>
> Type of the message (e.g., 'MESG' or 'FILE')
>
> **apns\_bundle\_id** `string`
>
> APNs bundle ID for iOS push notifications
>
> **sorted\_metaarray** `array`
>
> Sorted metaarray objects for the message
>
> **mentioned\_user\_ids** `array`
>
> List of user IDs to mention in the message
>
> **push\_notification\_delivery\_option** `string`
>
> Push notification delivery option ('default', 'suppress')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Sendbird User
>
> **Slug:** `SENDBIRD_UPDATE_USER`
>
> Tool to update a user's information. Use when modifying nickname, profile image URL, activation status, or metadata.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Unique ID of the user to update
>
> **metadata** `object`
>
> Custom key-value store for user metadata
>
> **nickname** `string`
>
> New display name for the user
>
> **is\_active** `boolean`
>
> Set to false to deactivate the user account
>
> **profile\_url** `string`
>
> URL of the new profile image
>
> **issue\_access\_token** `boolean`
>
> Whether to issue a new access token for the user
>
> **preferred\_languages** `array`
>
> List of language tags for localization
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sendbird View Group Channel
>
> **Slug:** `SENDBIRD_VIEW_GROUP_CHANNEL`
>
> Tool to view information about a specific group channel. Use when you need channel details after confirming the channel\_url.
>
> #### Input Parameters
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel to retrieve.
>
> **show\_member** `boolean`
>
> Whether to include the channel's member list in the response.
>
> **show\_metadata** `boolean`
>
> Whether to include channel metadata in the response.
>
> **show\_read\_receipt** `boolean`
>
> Whether to include read receipt information in the response.
>
> **show\_migration\_info** `boolean`
>
> Whether to include migration information in the response.
>
> **show\_delivery\_receipt** `boolean`
>
> Whether to include delivery receipt information in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Sendbird View Message
>
> **Slug:** `SENDBIRD_VIEW_MESSAGE`
>
> Tool to view a specific message in a group channel. Use after confirming channel\_url and message\_id.
>
> #### Input Parameters
>
> **message\_id** `integer` *required*
>
> Unique ID of the message.
>
> **channel\_url** `string` *required*
>
> URL-encoded identifier of the group channel.
>
> **with\_sorted\_metaarray** `boolean`
>
> Whether to include sorted\_metaarray arrays in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] View User
>
> **Slug:** `SENDBIRD_VIEW_USER`
>
> Tool to retrieve information about a specific Sendbird user. Use when you need to fetch detailed user data by their user ID.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique ID of the user to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
