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

# Kick

> Kick is a livestreaming platform whose Public API supports channels, streams, chat, moderation, rewards, ads, and event subscriptions.

![Kick logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/kick.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=9bb5b728bf25c53a4694793db410fbfa)

* **Category:** social media accounts
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 25
* **Triggers:** 0
* **Slug:** `KICK`
* **Version:** 20261101\_00

## Tools

> [accordion] Ban or Time Out User
>
> **Slug:** `KICK_BAN_OR_TIMEOUT_USER`
>
> Ban a user from a broadcaster chat, or apply a temporary timeout when duration\_minutes is supplied.
>
> #### Input Parameters
>
> **reason** `string`
>
> Moderator-visible reason for the ban or timeout.
>
> **user\_id** `integer` *required*
>
> User to ban or time out.
>
> **duration\_minutes** `integer`
>
> Timeout duration in minutes. Omit this field to permanently ban the user.
>
> **broadcaster\_user\_id** `integer` *required*
>
> Broadcaster whose chat will enforce the moderation 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] Create Channel Reward
>
> **Slug:** `KICK_CREATE_CHANNEL_REWARD`
>
> Create a channel point reward owned by the connected Kick app.
>
> #### Input Parameters
>
> **cost** `integer` *required*
>
> Channel point cost to redeem the reward.
>
> **title** `string` *required*
>
> Reward title shown to viewers.
>
> **is\_enabled** `boolean`
>
> Whether viewers can redeem the reward.
>
> **description** `string`
>
> Optional reward description shown to viewers.
>
> **background\_color** `string`
>
> Reward background color as a six-digit hexadecimal value.
>
> **is\_user\_input\_required** `boolean`
>
> Whether redemption requires viewer text input.
>
> **should\_redemptions\_skip\_request\_queue** `boolean`
>
> Whether redemptions are fulfilled without entering the request queue.
>
> #### 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 Event Subscriptions
>
> **Slug:** `KICK_CREATE_EVENT_SUBSCRIPTIONS`
>
> Create one or more webhook event subscriptions for the authorized broadcaster using the Kick app's configured callback.
>
> #### Input Parameters
>
> **events** `array` *required*
>
> Unique Kick event name and version pairs to subscribe to.
>
> **method** `string`
>
> Delivery method. Kick currently supports webhook delivery only.
>
> #### 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 Channel Reward
>
> **Slug:** `KICK_DELETE_CHANNEL_REWARD`
>
> Permanently delete a channel reward created by the connected Kick app.
>
> #### Input Parameters
>
> **reward\_id** `string` *required*
>
> ULID of the app-owned channel reward to permanently 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] Delete Chat Message
>
> **Slug:** `KICK_DELETE_CHAT_MESSAGE`
>
> Permanently delete a chat message by message ID using the connected moderator identity.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> ID of the chat message to permanently 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] Delete Event Subscriptions
>
> **Slug:** `KICK_DELETE_EVENT_SUBSCRIPTIONS`
>
> Permanently delete one or more webhook event subscriptions by ID.
>
> #### Input Parameters
>
> **subscription\_ids** `array` *required*
>
> Subscription IDs to permanently delete. Each ID is sent as a repeated id query parameter.
>
> #### 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] Enroll In Ads
>
> **Slug:** `KICK_ENROLL_IN_ADS`
>
> Irreversibly enroll the authorized broadcaster channel in Kick's ads program, changing account-level ad settings. Kick documents no API to unenroll 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] Get Ad Break Status
>
> **Slug:** `KICK_GET_AD_BREAK_STATUS`
>
> Return ad enrollment, blocking conditions, limits, remaining capacity, and recent ad breaks for the authorized 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 Channels
>
> **Slug:** `KICK_GET_CHANNELS`
>
> Return the authorized channel when no selector is supplied, or look up channels by broadcaster user IDs or slugs, without exposing stream credentials.
>
> #### Input Parameters
>
> **slugs** `array`
>
> Channel slugs to look up. Sent as repeated slug query keys; each slug is at most 25 characters and the list is mutually exclusive with broadcaster\_user\_ids.
>
> **broadcaster\_user\_ids** `array`
>
> Broadcaster user IDs to look up. Sent as repeated broadcaster\_user\_id query keys; mutually exclusive with slugs.
>
> #### 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 KICKs Leaderboard
>
> **Slug:** `KICK_GET_KICKS_LEADERBOARD`
>
> Return lifetime, monthly, and weekly KICKs leaderboards for the authorized broadcaster.
>
> #### Input Parameters
>
> **top** `integer`
>
> Maximum ranked users to return in each leaderboard period (1-100).
>
> #### 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 Livestream Stats
>
> **Slug:** `KICK_GET_LIVESTREAM_STATS`
>
> Return the current aggregate count of active livestreams on Kick.
>
> #### 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 Livestreams
>
> **Slug:** `KICK_GET_USER_LIVESTREAMS`
>
> Return active Kick livestreams for 1 to 100 specific user IDs.
>
> #### Input Parameters
>
> **user\_ids** `array` *required*
>
> User IDs whose active livestreams to return. Each ID is sent as a repeated user\_id query key; provide between 1 and 100 IDs.
>
> #### 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 Users
>
> **Slug:** `KICK_GET_USERS`
>
> Return the authorized Kick user when no IDs are supplied, or look up users by ID.
>
> #### Input Parameters
>
> **user\_ids** `array`
>
> User IDs to look up. Each ID is sent as a repeated id query key. Omit this field to return the authorized 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] Get Webhook Public Key
>
> **Slug:** `KICK_GET_WEBHOOK_PUBLIC_KEY`
>
> Return Kick's PEM public key for verifying signatures on received webhook events.
>
> #### 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 Categories
>
> **Slug:** `KICK_LIST_CATEGORIES`
>
> Find Kick categories by names, tags, or IDs and return one cursor-paginated page.
>
> #### Input Parameters
>
> **tags** `array`
>
> Category tags to match; values are sent as one comma-separated tag query parameter.
>
> **limit** `integer`
>
> Maximum categories to return in this page (1-1000).
>
> **names** `array`
>
> Category names to match; values are sent as one comma-separated name query parameter.
>
> **cursor** `string`
>
> Opaque next cursor from a previous response; omit for the first page.
>
> **category\_ids** `array`
>
> Category IDs to retrieve; values are sent as one comma-separated id query parameter.
>
> #### 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 Channel Rewards
>
> **Slug:** `KICK_LIST_CHANNEL_REWARDS`
>
> Return all channel point rewards on the authorized broadcaster's 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] List Event Subscriptions
>
> **Slug:** `KICK_LIST_EVENT_SUBSCRIPTIONS`
>
> List webhook event subscriptions owned by the connected Kick app, optionally for one broadcaster.
>
> #### Input Parameters
>
> **broadcaster\_user\_id** `integer`
>
> Only return subscriptions for this broadcaster's numeric Kick user ID.
>
> #### 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 Livestreams
>
> **Slug:** `KICK_LIST_LIVESTREAMS`
>
> Discover active Kick livestreams by category or language and return one cursor-paginated page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum livestreams to return in this page (1-1000).
>
> **cursor** `string`
>
> Opaque next cursor from a previous response; omit for the first page.
>
> **category\_ids** `array`
>
> Category IDs to include; each value is sent as a repeated category\_id query key (maximum 25).
>
> **language\_codes** `array`
>
> BCP 47 language codes to include; each value is sent as a repeated language\_code query key (maximum 25).
>
> #### 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 Reward Redemptions
>
> **Slug:** `KICK_LIST_REWARD_REDEMPTIONS`
>
> Return one page of channel reward redemptions filtered by reward and status, or by redemption IDs. Status defaults to pending unless redemption IDs are supplied.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Opaque next cursor from a previous response; omit for the first page.
>
> **status** `string ("pending" | "accepted" | "rejected")`
>
> Redemption status to return; defaults to pending and cannot be used with redemption\_ids.
>
> **reward\_id** `string`
>
> Reward ULID whose redemptions to return; cannot be used with redemption\_ids.
>
> **redemption\_ids** `array`
>
> Specific redemption ULIDs. Each value is sent as a repeated id query key; cannot be combined with reward\_id or status.
>
> #### 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 Moderation Ban
>
> **Slug:** `KICK_REMOVE_MODERATION_BAN`
>
> Remove a user's ban or active timeout from a broadcaster chat.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> User whose ban or timeout should be removed.
>
> **broadcaster\_user\_id** `integer` *required*
>
> Broadcaster whose chat contains the ban or timeout.
>
> #### 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] Resolve Reward Redemptions
>
> **Slug:** `KICK_RESOLVE_REWARD_REDEMPTIONS`
>
> Accept or reject up to 25 pending channel reward redemptions in one explicit decision.
>
> #### Input Parameters
>
> **decision** `string ("accept" | "reject")` *required*
>
> Final status to apply to all supplied pending redemptions.
>
> **redemption\_ids** `array` *required*
>
> One to 25 unique pending redemption ULIDs to accept or reject.
>
> #### 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 Chat Message
>
> **Slug:** `KICK_SEND_CHAT_MESSAGE`
>
> Immediately send a Kick chat message as the authorized user or connected bot, optionally as a reply.
>
> #### Input Parameters
>
> **content** `string` *required*
>
> Chat message text to send immediately, limited to 500 grapheme clusters and 2048 UTF-8 bytes.
>
> **sender\_type** `string ("user" | "bot")` *required*
>
> Send as the authorized user or the connected bot.
>
> **broadcaster\_user\_id** `integer`
>
> Destination broadcaster ID. Required when sender\_type is user and forbidden when sender\_type is bot.
>
> **reply\_to\_message\_id** `string`
>
> Message UUID to reply to, if this message is a reply.
>
> #### 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] Start Ad Break
>
> **Slug:** `KICK_START_AD_BREAK`
>
> Immediately start an ad break on the authorized live Kick broadcaster channel when its ad capabilities permit it.
>
> #### Input Parameters
>
> **request\_id** `string` *required*
>
> Caller-generated UUID used by Kick as the idempotency and request ID. Reuse the same UUID only when retrying the same intended ad break; use a new UUID for a new ad break.
>
> **duration\_seconds** `integer` *required*
>
> Length of the ad break in seconds, from 7 through 90.
>
> #### 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
>
> **Slug:** `KICK_UPDATE_CHANNEL`
>
> Update one or more metadata fields on the authorized broadcaster's livestream channel.
>
> #### Input Parameters
>
> **category\_id** `integer`
>
> Category ID to assign to the authorized broadcaster's channel.
>
> **custom\_tags** `array`
>
> Complete custom-tag list to set on the channel. Pass an empty list to clear all custom tags.
>
> **stream\_title** `string`
>
> New livestream title for the authorized broadcaster's 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] Update Channel Reward
>
> **Slug:** `KICK_UPDATE_CHANNEL_REWARD`
>
> Update one or more fields on a channel reward created by the connected Kick app.
>
> #### Input Parameters
>
> **cost** `integer`
>
> Replacement channel point cost to redeem the reward.
>
> **title** `string`
>
> Replacement reward title shown to viewers.
>
> **is\_paused** `boolean`
>
> Whether reward redemptions are temporarily paused.
>
> **reward\_id** `string` *required*
>
> ULID of the app-owned channel reward to update.
>
> **is\_enabled** `boolean`
>
> Whether viewers can redeem the reward.
>
> **description** `string`
>
> Replacement reward description shown to viewers.
>
> **background\_color** `string`
>
> Replacement reward background color as a six-digit hex value.
>
> **is\_user\_input\_required** `boolean`
>
> Whether redemption requires viewer text input.
>
> **should\_redemptions\_skip\_request\_queue** `boolean`
>
> Whether redemptions bypass the request queue.
>
> #### 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
