---
canonical_url: "https://docs.composio.dev/toolkits/botpenguin"
markdown_url: "https://docs.composio.dev/toolkits/botpenguin.md"
product: "platform"
version: null
last_updated: null
---

# BotPenguin

BotPenguin is an AI chatbot platform for managing contacts, conversations, bot integrations, and cross-platform customer messaging.

- **Category:** ai chatbots
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `BOTPENGUIN`
- **Version:** 00000000_00

## Tools

### Get Template Dynamic Fields

**Slug:** `BOTPENGUIN_GET_TEMPLATE_DYNAMIC_FIELDS`

Return the dynamic key-value fields required by a BotPenguin WhatsApp template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template ID returned by List WhatsApp Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Contacts

**Slug:** `BOTPENGUIN_IMPORT_CONTACTS`

Import contacts in bulk into BotPenguin. Existing contacts may be updated, and the operation does not return contact IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | Contacts to import; each item accepts a name, optional email and phone details, tags, and custom attributes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inbox Contacts

**Slug:** `BOTPENGUIN_LIST_INBOX_CONTACTS`

Return one page of BotPenguin inbox contacts filtered by whether the contact has interacted with a bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-based result page to return; increase it until contacts is empty. |
| `user_interacted` | boolean | No | Return contacts whose bot-interaction state matches this value; this is the filter verified live. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Segments

**Slug:** `BOTPENGUIN_LIST_SEGMENTS`

List the contact segments configured in the connected BotPenguin account, including each segment's filter definition and contact count.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Bots

**Slug:** `BOTPENGUIN_LIST_WHATSAPP_BOTS`

List WhatsApp bots available to the connected BotPenguin account for use with plugin template tools.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WhatsApp Templates

**Slug:** `BOTPENGUIN_LIST_WHATSAPP_TEMPLATES`

List WhatsApp templates available to a BotPenguin bot.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bot_id` | string | Yes | WhatsApp bot ID returned by List WhatsApp Bots. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |