Back to Home
Dashboard

Lead API Endpoints

Complete CRUD operations for managing leads

REST API
5 operations

Base URL & Authentication

All Lead API endpoints use the same base configuration

Base URL

$https://your-domain.com/api/v1/chatbots/{chatbotId}

Required Headers

Authorization: Bearer sk-workspace_your_api_key_here
Content-Type: application/json

Path Parameters

chatbotId

The unique identifier of the chatbot (required)

string

Create Lead

Add a new lead to your chatbot

POST
Endpoint
POST /api/v1/chatbots/{chatbotId}/leads
Key Features
  • Required fields validation
  • Custom metadata support
  • Automatic ID generation
View Details

List Leads

Retrieve leads with filtering and pagination

GET
Endpoint
GET /api/v1/chatbots/{chatbotId}/leads
Key Features
  • Advanced filtering
  • Pagination support
  • Search functionality
View Details

Get Lead

Retrieve a specific lead by ID

GET
Endpoint
GET /api/v1/chatbots/{chatbotId}/leads/{id}
Key Features
  • Complete lead data
  • Metadata included
  • Fast lookup
View Details

Update Lead

Modify an existing lead's information

PUT
Endpoint
PUT /api/v1/chatbots/{chatbotId}/leads/{id}
Key Features
  • Partial updates
  • Metadata merging
  • Status tracking
View Details

Delete Lead

Permanently remove a lead

DELETE
Endpoint
DELETE /api/v1/chatbots/{chatbotId}/leads/{id}
Key Features
  • Permanent deletion
  • Confirmation required
  • Audit logging
View Details

Quick Reference

Common patterns and status codes for all endpoints

✓ Success Responses

200
OK - Request successful
201
Created - Lead created successfully

✗ Common Errors

400
Bad Request - Invalid data
401
Unauthorized - Invalid API key
404
Not Found - Lead doesn't exist
429
Rate Limited - Too many requests

Available Status Values

new
contacted
qualified
converted
lost
follow_up
Choose Your Operation

Select any operation above to see detailed documentation, examples, and implementation guides.

Start with CreateError Handling
    PollyBot.ai - Smart Conversations, Seamless Automation