> ## 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.

# Revolt

> Revolt is a free and open-source chat platform offering secure and customizable communication.

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

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

## Tools

> [accordion] Acknowledge Policy Changes
>
> **Slug:** `REVOLT_ACKNOWLEDGE_POLICY_CHANGES`
>
> Tool to acknowledge platform policy changes. Use when accepting or confirming policy updates for your bot account.
>
> #### 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] Add Reaction to Message
>
> **Slug:** `REVOLT_ADD_CHANNELS_MESSAGES_REACTIONS`
>
> Tool to add a reaction to a message in a channel. Use when you want to react with an emoji to a specific message. Returns success on completion.
>
> #### Input Parameters
>
> **msg** `string` *required*
>
> The ID of the message to react to
>
> **emoji** `string` *required*
>
> The emoji to use for the reaction. Can be a unicode emoji or custom emoji ID. Provide the raw emoji character (e.g., 👍) or custom emoji ID - encoding is handled automatically.
>
> **target** `string` *required*
>
> The ID of the channel containing the message
>
> #### 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] Block User
>
> **Slug:** `REVOLT_BLOCK_USER`
>
> Tool to block another user by their ID. Use when you need to prevent interactions with a specific user.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the user to block
>
> #### 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 Sync Settings
>
> **Slug:** `REVOLT_CREATE_SYNC_SETTINGS_SET`
>
> Tool to upload and save settings data to Revolt's sync storage. Use when you need to persist user settings or preferences.
>
> #### Input Parameters
>
> **settings** `object` *required*
>
> Key-value pairs of settings to save. Keys and values must be strings.
>
> **timestamp** `integer`
>
> Timestamp of settings change in milliseconds. Used to avoid feedback loops.
>
> #### 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:** `REVOLT_DELETE_MESSAGE`
>
> Tool to delete a message you've sent or one you have permission to delete. Use when you need to remove a message from a channel.
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> The ID of the channel containing the message to delete
>
> **message\_id** `string` *required*
>
> The ID of the message to delete
>
> #### 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] Bulk Delete Messages
>
> **Slug:** `REVOLT_DELETE_MESSAGES_BULK`
>
> Tool to bulk delete multiple messages from a channel. Use when you need to delete multiple messages at once. Requires ManageMessages permission regardless of message ownership. Messages must have been sent within the past 1 week.
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> The ID of the channel containing the messages to delete
>
> **message\_ids** `array` *required*
>
> List of message IDs to delete. Messages must have been sent within the past 1 week. You must either own the messages or have ManageMessages permission.
>
> #### 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] Fetch Owned Bots
>
> **Slug:** `REVOLT_FETCH_OWNED_BOTS`
>
> Tool to fetch all bots that you have control over. Use when you need to retrieve information about bots owned by the authenticated user account.
>
> #### 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] Fetch Sync Settings
>
> **Slug:** `REVOLT_FETCH_SYNC_SETTINGS`
>
> Fetch server sync settings by key. Returns a settings object mapping returned keys to objects containing their timestamp and value.
>
> #### Input Parameters
>
> **keys** `array` *required*
>
> List of setting keys to fetch from the server
>
> #### 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] Fetch user
>
> **Slug:** `REVOLT_FETCH_USER`
>
> Tool to fetch detailed information about a user. Use when you have a valid user ID and need full account details. Call after authenticating with bot token.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The ID of the user to fetch
>
> #### 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] Fetch User Flags
>
> **Slug:** `REVOLT_FETCH_USER_FLAGS`
>
> Tool to fetch flags associated with a specific user. Use after obtaining the user ID to inspect their special statuses or roles.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique identifier of the user whose flags will be fetched
>
> #### 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 API Info
>
> **Slug:** `REVOLT_GET_API_INFO`
>
> Tool to fetch the server configuration for this Revolt instance. Use when you need to discover API version, feature availability, WebSocket endpoints, or service URLs.
>
> #### 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 Channel
>
> **Slug:** `REVOLT_GET_CHANNEL`
>
> Tool to fetch a channel by its ID. Use when you need to retrieve detailed information about a specific channel.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the channel to fetch
>
> #### 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 Current User
>
> **Slug:** `REVOLT_GET_CURRENT_USER`
>
> Tool to retrieve your own user information. Use when you need to fetch details about the authenticated user account.
>
> #### 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 Invite
>
> **Slug:** `REVOLT_GET_INVITE`
>
> Tool to fetch detailed information about an invite by its code. Use when you have a valid invite code and need to retrieve invite details including server info, channel info, and member count.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The invite code to fetch (e.g., 'API', 'abc123')
>
> #### 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 Sync Unreads
>
> **Slug:** `REVOLT_GET_SYNC_UNREADS`
>
> Tool to fetch information about unread state on channels. Use when you need to check which channels have unread messages or mentions.
>
> #### 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 Profile
>
> **Slug:** `REVOLT_GET_USER_PROFILE`
>
> Tool to retrieve a user's profile data including bio and background. Use when you need profile-specific information beyond basic user data. Will fail if you do not have permission to access the target user's profile.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the user whose profile to fetch
>
> #### 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's Default Avatar
>
> **Slug:** `REVOLT_GET_USERS_DEFAULT_AVATAR`
>
> Tool to fetch a user's default avatar image based on their ID. Use when you need to retrieve the default avatar picture for a specific user.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the user whose default avatar will be fetched
>
> #### 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] Open DM with User
>
> **Slug:** `REVOLT_GET_USERS_DM`
>
> Tool to open a DM with another user. Use when you need to start or access a direct message conversation. If the target is oneself, returns a saved messages channel.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the user to open a DM with. If the target is the authenticated user themselves, a saved messages channel is returned.
>
> #### 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 DMs
>
> **Slug:** `REVOLT_GET_USERS_DMS`
>
> Tool to fetch all direct message conversations for the authenticated user. Use when you need to list all DM and group DM channels.
>
> #### 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] Pin Message
>
> **Slug:** `REVOLT_PIN_MESSAGE`
>
> Tool to pin a message in a channel by its ID. Use when you need to highlight important messages for channel members.
>
> #### Input Parameters
>
> **msg** `string` *required*
>
> The ID of the message to pin
>
> **target** `string` *required*
>
> The ID of the channel containing the message
>
> #### 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] Remove Message Reaction
>
> **Slug:** `REVOLT_REMOVE_MESSAGE_REACTION`
>
> Tool to remove a reaction from a message. Use when you need to remove your own, someone else's, or all reactions of a given emoji from a message. Requires ManageMessages permission if removing others' reactions.
>
> #### Input Parameters
>
> **msg** `string` *required*
>
> The ID of the message to remove the reaction from
>
> **emoji** `string` *required*
>
> The emoji to remove from the message (can be unicode emoji or custom emoji ID)
>
> **target** `string` *required*
>
> The ID of the channel containing the message
>
> **user\_id** `string`
>
> Remove a specific user's reaction. Requires ManageMessages permission if removing others' reactions. If not specified, removes your own reaction.
>
> **remove\_all** `boolean`
>
> Remove all reactions of this emoji type from the message. Requires ManageMessages permission.
>
> #### 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 Channel Message
>
> **Slug:** `REVOLT_SEND_CHANNELS_MESSAGES`
>
> Send a message to a Revolt channel using a bot token. The message must include nonempty text or attachments and may also include embeds.
>
> #### Input Parameters
>
> **flags** `integer`
>
> Bitfield of message flags (see [https://docs.rs/revolt-models/latest/revolt\_models/v0/enum.MessageFlags.html](https://docs.rs/revolt-models/latest/revolt_models/v0/enum.MessageFlags.html))
>
> **nonce** `string`
>
> Deprecated: Unique token to prevent duplicate message sending. Use Idempotency-Key header instead
>
> **embeds** `array`
>
> List of embeds to include in message. Text embed content contributes to the content length cap
>
> **target** `string` *required*
>
> ID of the channel to send the message to
>
> **content** `string`
>
> Message content to send (max 2000 characters)
>
> **replies** `array`
>
> List of messages to reply to
>
> **masquerade** `object`
>
> Masquerade to apply to this message.
>
> **attachments** `array`
>
> List of attachment file IDs to include in message
>
> **interactions** `object`
>
> Information about how this message should be interacted with.
>
> **idempotency\_key** `string`
>
> Unique key to prevent duplicate requests. Sent as Idempotency-Key header
>
> #### 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] Unblock User
>
> **Slug:** `REVOLT_UNBLOCK_USER`
>
> Unblock another user by their ID to remove a block on that user.
>
> #### Input Parameters
>
> **target** `string` *required*
>
> The ID of the user to unblock
>
> #### 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] Unpin Message
>
> **Slug:** `REVOLT_UNPIN_MESSAGE`
>
> Tool to unpin a message in a channel. Use when you need to remove a pinned message from the channel's pinned messages list.
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> The ID of the channel containing the message
>
> **message\_id** `string` *required*
>
> The ID of the message to unpin
>
> #### 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 Channel Message
>
> **Slug:** `REVOLT_UPDATE_CHANNELS_MESSAGES`
>
> Tool to edit a message that you've previously sent in a channel. Use when you need to update the content or embeds of an existing message. At least one of content or embeds must be provided.
>
> #### Input Parameters
>
> **msg** `string` *required*
>
> The ID of the message to edit
>
> **embeds** `array`
>
> Embeds to include in the message. Maximum of 10 embeds allowed.
>
> **target** `string` *required*
>
> The ID of the channel containing the message
>
> **content** `string`
>
> New message content to replace the existing message text
>
> #### 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 User
>
> **Slug:** `REVOLT_UPDATE_USER`
>
> Tool to update user information. Use when you need to modify user profile or status fields. Call after authenticating with bot token.
>
> #### Input Parameters
>
> **clear** `array`
>
> List of profile fields to clear
>
> **avatar** `string`
>
> Avatar file ID to set as new avatar
>
> **user\_id** `string` *required*
>
> The ID of the user to update
>
> **status\_text** `string`
>
> New status text for the user
>
> **profile\_content** `string`
>
> Profile content asset ID or base64 data
>
> **profile\_background** `string`
>
> Profile background asset ID or base64 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
