Skip to content
Docs
Search
Ctrl
K
Cancel
Ask AI
Status
Website
Dashboard
Select theme
Dark
Light
Auto
EN
Select language
English
Français
Español
Dashboard
Dashboard
Guides
Developers
API reference
Start here
Welcome
Create your first agent
Connect a WhatsApp number
Bring contacts to your agent
The Academy
Overview & search bar
Your agents
Agents
Your agent's prompt
Test your agent
A/B variants
Automatic follow-ups
Meetings
Notifications & alerts
Knowledge bases
My Styles
Run
Conversations
Take over a conversation
WhatsApp groups
Leads & CRM
Agent labels
Analytics
Reach out
Lists & import
Tracked links
Forms
Channels
WhatsApp numbers
Instagram and Messenger
How we protect your number
Account
Team, profiles & access
Subscription & billing
Settings
Blocked numbers
Ask AI
Status
Website
Dashboard
Select theme
Dark
Light
Auto
Select language
English
Français
Español
Getting started
Developer hub
Quickstart
Authentication & permissions
Errors, limits & idempotency
Guides by resource
Leads
Lists & import
Campaigns
Agent prompts
Knowledge bases
Messages
Conversations
Instagram & Messenger
Meetings
Groups
Blocked numbers
Team members
Tracked links
Integrations
Signed webhooks
MCP server (AI agents)
Use these docs with AI
Ask AI
Status
Website
Dashboard
Select theme
Dark
Light
Auto
Select language
English
Français
Español
API Reference
Overview
Keys
Overview
Identify the calling key
GET
Leads
Overview
List leads
GET
Get a lead
GET
Update a lead
PATCH
Take the conversation over (stops the AI agent)
POST
Give the conversation back to the AI agent
POST
List a lead's notes
GET
Add a note to a lead
POST
Conversations
Overview
List conversations (inbox)
GET
Get a conversation transcript
GET
Lists
Overview
List lead lists
GET
Create a list
POST
Push leads into a list
POST
Campaigns
Overview
List campaigns
GET
Pause a campaign
POST
Resume a paused campaign
POST
Add an opt-in lead (sends their first message)
POST
Prompts
Overview
Get an agent's prompts
GET
Get one prompt
GET
Change a prompt
PUT
List the versions of a prompt
GET
Get one version of a prompt
GET
Compare two versions of a prompt
GET
Restore a version of a prompt
POST
Knowledge
Overview
List knowledge bases
GET
Get a knowledge base
GET
Search a knowledge base as the agent does
GET
List the answers of a knowledge base
GET
Add an answer to a knowledge base
POST
Remove an answer
DELETE
Correct an answer
PATCH
Add a text file
POST
Read a file
GET
Remove a file
DELETE
Rewrite a text file
PATCH
Instagram
Overview
List planned Instagram posts
GET
Publish or schedule an Instagram post
POST
Get a planned Instagram post
GET
Cancel a planned Instagram post
DELETE
Change a planned Instagram post
PATCH
Instagram posts with their numbers and their funnel
GET
Best times to post on an Instagram account
GET
List Instagram accounts
GET
List Instagram automations
GET
Create an Instagram automation
POST
Delete an Instagram automation
DELETE
Change an Instagram automation
PATCH
Instagram automation numbers over a period
GET
Messages
Overview
Send a message to a lead (WhatsApp, Instagram, Messenger)
POST
Bookings
Overview
List bookings
GET
Groups
Overview
List WhatsApp groups
GET
Get a WhatsApp group
GET
List group members
GET
List group messages
GET
List group join / leave events
GET
Webhooks
Overview
List webhook subscriptions
GET
Create a webhook subscription
POST
Delete a webhook subscription
DELETE
Send a test delivery now
POST
Blocklist
Overview
List blocked numbers and prefixes
GET
Block a number or a dial prefix
POST
Unblock (remove a rule)
DELETE
Team
Overview
List team members
GET
Links
Overview
List tracked links
GET
Get a tracked link with its stats
GET
Try it live
Interactive playground ↗
Ask AI
Status
Website
Dashboard
Select theme
Dark
Light
Auto
Select language
English
Français
Español
Leads
Copy page
Open in Claude
Open in ChatGPT
View as Markdown
Overview
Leads
Section titled “Leads”
The people your AI setter talks to.
Operations
Section titled “Operations”
GET
/leads
GET
/leads/{id}
PATCH
/leads/{id}
POST
/leads/{id}/handoff
POST
/leads/{id}/resume
GET
/leads/{id}/notes
POST
/leads/{id}/notes