# Chat alerts API

> KickBot API and MCP reference for chat alerts: read and change the chat messages KickBot posts for subs, gifted subs, follows and KICKs.

Source: https://kickbot.com/docs/api/reference/chat-alerts

Use these actions to read and change chat alerts, the messages KickBot posts in chat when someone follows, subscribes, gifts subs or sends KICKs.

Each action is a REST endpoint under `https://kickbot.com/api/v1` and an MCP tool with the same name. The MCP area name is `chat_alerts`. Use it to load only this area: `https://kickbot.com/api/v1/mcp?areas=chat_alerts`.

A team member needs the **Chat alerts** permission in Manage Team. Owners and admins have every permission. Write actions also need a read and write key or connection. See [Permissions and security](https://kickbot.com/docs/api/start/permissions-and-security).

How the feature works in the dashboard: [Chat alerts](https://kickbot.com/docs/alerts/chat-alerts).

## Actions

| Tool | REST | Access |
|---|---|---|
| [`get_chat_alert_settings`](#get_chat_alert_settings) | `GET /chat-alerts/settings` | Read |
| [`update_chat_alert_settings`](#update_chat_alert_settings) | `PATCH /chat-alerts/settings` | Write |

## get_chat_alert_settings

**Get the chat alert settings.** Read the chat messages KickBot posts for subs, gifted subs, follows, and KICKs: on/off, text, and minimum amounts.

```http
GET /api/v1/chat-alerts/settings
```

No input fields.

## update_chat_alert_settings

**Update the chat alert settings.** Change some chat alert settings. Only the fields you send change. Requires a verified account.

```http
PATCH /api/v1/chat-alerts/settings
```

Needs a read and write key or connection.

| Field | Type | Required | Description |
|---|---|---|---|
| `sub_alert_enabled` | boolean | No | Post a chat message for new subscriptions and resubs. |
| `sub_alert_text` | string | No | Message for subs. Variables: {{username}}, {{months}}. Default "@{{username}} has subbed for {{months}}!". 15-300 characters. |
| `gifted_sub_alert_enabled` | boolean | No | Post a chat message for gifted subs. |
| `gifted_sub_alert_text` | string | No | Message for gifted subs. Variables: {{username}}, {{sub_count}}. Default "@{{username}} just gifted {{sub_count}}!". 15-300 characters. |
| `gifted_sub_alert_min_amount` | integer | No | Gifted subs: number of subs in one gift. Minimum before the alert is posted. 0 (default) posts every time. |
| `follow_alert_enabled` | boolean | No | Post a chat message for new followers. |
| `follow_alert_text` | string | No | Message for follows. Variable: {{username}}. Default "Thanks for the follow @{{username}}". 15-300 characters. |
| `kicks_alert_enabled` | boolean | No | Post a chat message when someone gifts KICKs. |
| `kicks_alert_text` | string | No | Message for KICKs. Variables: {{username}}, {{amount}}. Default "@{{username}} just gifted {{amount}} KICKs!". 15-300 characters. |
| `kicks_alert_min_amount` | integer | No | KICKs: number of KICKs in one gift. Minimum before the alert is posted. 0 (default) posts every time. |