> For the complete documentation index, see [llms.txt](https://help.botpenguin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.botpenguin.com/api-documentation.md).

#  Api Documentation

- [Contacts & Chats APIs](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis.md): The Contacts & Chats APIs allow you to programmatically manage contacts, retrieve chat and lead data, update user statuses, and modify chat records from any external system or integration.
- [GET — Segments / Groups](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/get-segments-groups.md): Retrieve all groups configured in your BotPenguin account.
- [GET — Chats / Leads Listing](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/get-chats-leads-listing.md): Retrieve a paginated list of chats or leads and their metadata for a specific bot. Use the type parameter to switch between leads and non-lead chats.
- [POST — Add WhatsApp Contact](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/post-add-whatsapp-contact.md): Import one or more WhatsApp contacts into BotPenguin. Use this API to create new contacts or update existing ones with profile details including name, email, phone, tags, and custom attributes.
- [POST — Get User Inbox](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/post-get-user-inbox.md): Retrieve a paginated list of contacts and their conversation metadata from the BotPenguin inbox. Supports filtering by platform, agent, status, tags, segments, date ranges, and more.
- [PUT — Update User Status](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/put-update-user-status.md): Update the status of one or more contacts in your BotPenguin inbox. Currently supports marking contacts as DELETED.
- [PUT — Update Chat / Lead Data](https://help.botpenguin.com/api-documentation/contacts-and-chats-apis/put-update-chat-lead-data.md): Create or update a lead's profile data in BotPenguin. As soon as a user opens the bot, a UUID is generated for that session — pass it along with the bot and customer IDs to create or update the lead's
- [WhatsApp Cloud API](https://help.botpenguin.com/api-documentation/whatsapp-cloud-api.md): This page contains all the open APIs available for the WhatsApp
- [GET — Templates List](https://help.botpenguin.com/api-documentation/whatsapp-cloud-api/get-templates-list.md): Retrieve all WhatsApp templates associated with a bot, across all statuses — APPROVED, PENDING, REJECTED, and DRAFT. Use this to render, manage, or trigger templates programmatically.
- [POST WhatsApp Template Message](https://help.botpenguin.com/api-documentation/whatsapp-cloud-api/post-whatsapp-template-message.md): This article contains essential information and usage guidelines for sending WhatsApp Template Messages through the BotPenguin API.
- [POST — Send WhatsApp Message](https://help.botpenguin.com/api-documentation/whatsapp-cloud-api/post-send-whatsapp-message.md): Use this API to send a WhatsApp message to a specific user — either a plain text message or a media message with an image and caption. The recipient is identified by their WhatsApp number with country


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.botpenguin.com/api-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.