# Kick

> Read channels, categories, livestreams and rewards; manage chat, moderation and channel rewards.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/kick

## Actions

### Accept reward redemptions

Accept Channel Reward Redemptions.

**Inputs**

- Ids (`ids`, list, required): List of redemption IDs to accept. A maximum of 25 redemptions can be accepted per request. IDs must be unique.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### Ban user

Ban a viewer from a channel's chat, or time them out for a number of minutes, with an optional reason.

**Inputs**

- Broadcaster user (`broadcaster_user_id`, text, required): Broadcaster user ID.
- Duration (`duration`, number): To ban a user, don't include this field. To put a user in a timeout, include the timeout period in minutes. From 1 to 10080.
- Reason (`reason`, text): Reason.
- Member ID (`member_id`, text, required): Member ID.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {},
    "message": "example"
  }
}
```

### Create channel reward

Create Channel Reward.

**Inputs**

- Background color (`background_color`, text): Background color. Default: `#00e701`.
- Cost (`cost`, number, required): Cost. At least 1.
- Description (`description`, text): Description.
- Is enabled (`is_enabled`, true/false): Is enabled. Default: `true`.
- Is user input required (`is_user_input_required`, true/false): Is user input required. Default: `false`.
- Should redemptions skip request queue (`should_redemptions_skip_request_queue`, true/false): Should redemptions skip request queue. Default: `false`.
- Title (`title`, text, required): Title.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "background_color": "example",
      "cost": 1,
      "description": "example",
      "id": "example",
      "is_enabled": false,
      "is_paused": false,
      "is_user_input_required": false,
      "should_redemptions_skip_request_queue": false,
      "title": "example"
    },
    "message": "example"
  }
}
```

### Delete channel reward

Delete Channel Reward.

**Inputs**

- Id (`id`, text, required): Reward ID

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete chat message

Delete Chat Message.

**Inputs**

- Message ID (`message_id`, text, required): Message ID

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {}
}
```

### Get category

Get Category.

**Inputs**

- Category ID (`category_id`, text, required): Category ID

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "id": 1,
      "name": "example",
      "tags": [],
      "thumbnail": "example",
      "viewer_count": 1
    },
    "message": "example"
  }
}
```

### Get channels

Get Channels.

**Inputs**

- Broadcaster user (`broadcaster_user_id`, list): Broadcaster User IDs (cannot be used with slug)
- Slug (`slug`, list): Channel slugs (cannot be used with broadcaster_user_id)

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### Get KICKs leaderboard

Get KICKs Leaderboard.

**Inputs**

- Top (`top`, number): The number of entries from the top of the leaderboard to return. For example, 10 will fetch the top 10 entries. From 1 to 100. Default: `10`.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "lifetime": [],
      "month": [],
      "week": []
    },
    "message": "example"
  }
}
```

### Get livestream statistics

Get Livestreams Stats.

**Inputs**: None.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "total_count": 1
    },
    "message": "example"
  }
}
```

### Get users

Get Users.

**Inputs**

- Id (`id`, list): User IDs

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### List categories

Get Categories.

**Inputs**

- Q (`q`, text, required): Search query
- Page (`page`, number): Page (defaults to 1 if not provided). Default: `1`.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### List channel rewards

Get Channel Rewards.

**Inputs**: None.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### List livestreams

Get Livestreams.

**Inputs**

- Broadcaster user (`broadcaster_user_id`, list): Broadcaster User IDs (up to 50)
- Category ID (`category_id`, text): Category ID
- Language (`language`, text): Language of the livestream
- Limit (`limit`, number): Limit the number of results. From 1 to 100. Default: `25`.
- Sort (`sort`, text): Sort by viewer_count or started_at. One of: `viewer_count` (Viewer count), `started_at` (Started at). Default: `viewer_count`.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### List reward redemptions

Get Channel Reward Redemptions.

**Inputs**

- Reward (`reward_id`, text): Optionally provide a reward ID to list redemptions for that specific reward.
- Status (`status`, text): Optionally provide a specific status to filter by. Defaults to pending. One of: `pending`, `accepted`, `rejected`.
- Id (`id`, list): Optionally provide a list of redemption IDs to filter by. You cannot provide any other filters if you filter by redemption IDs.
- Cursor (`cursor`, text): Optionally provide a cursor to paginate through the results.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example",
    "pagination": {
      "next_cursor": "example"
    }
  }
}
```

### Reject reward redemptions

Reject Channel Reward Redemptions.

**Inputs**

- Ids (`ids`, list, required): List of redemption IDs to reject. A maximum of 25 redemptions can be rejected per request. IDs must be unique.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "message": "example"
  }
}
```

### Send chat message

Post Chat Message.

**Inputs**

- Broadcaster user (`broadcaster_user_id`, text): Broadcaster user ID.
- Content (`content`, text, required): Content.
- Reply to message ID (`reply_to_message_id`, text): Reply to message ID.
- Type (`type`, text, required): Type. One of: `user`, `bot`.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "is_sent": false,
      "message_id": "example"
    },
    "message": "example"
  }
}
```

### Unban user

Lift a ban or timeout so a viewer can chat in the channel again.

**Inputs**

- Broadcaster user (`broadcaster_user_id`, text, required): Broadcaster user ID.
- Member ID (`member_id`, text, required): Member ID.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {},
    "message": "example"
  }
}
```

### Update channel

Patch Channels.

**Inputs**

- Category ID (`category_id`, text): Category ID.
- Custom tags (`custom_tags`, list): Custom tags.
- Stream title (`stream_title`, text): Stream title.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {}
}
```

### Update channel reward

Update Channel Reward.

**Inputs**

- Id (`id`, text, required): Reward ID
- Background color (`background_color`, text): Background color.
- Cost (`cost`, number): Cost. At least 1.
- Description (`description`, text): Description.
- Is enabled (`is_enabled`, true/false): Is enabled.
- Is paused (`is_paused`, true/false): Is paused.
- Is user input required (`is_user_input_required`, true/false): Is user input required.
- Should redemptions skip request queue (`should_redemptions_skip_request_queue`, true/false): Should redemptions skip request queue.
- Title (`title`, text): Title.

**Outputs**

- `data` (object): Kick response data.

**Example output**

```json
{
  "data": {
    "data": {
      "background_color": "example",
      "cost": 1,
      "description": "example",
      "id": "example",
      "is_enabled": false,
      "is_paused": false,
      "is_user_input_required": false,
      "should_redemptions_skip_request_queue": false,
      "title": "example"
    },
    "message": "example"
  }
}
```
