Leads, contacts and everything that organises them.
All paths below are relative to https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.
Leads
Deletes are soft (isDeleted) and go through DELETE /lead with ids in the body — there is no DELETE /lead/:id. See the Leads guide.
| Method | Endpoint | Description |
|---|
GET | /lead | List leads |
POST | /lead | Create a lead |
PUT | /lead | Update many leads |
DELETE | /lead | Delete leads (soft) |
GET | /lead/:id | Get one lead |
PUT | /lead/:id | Update lead |
POST | /lead/bulk | Create up to 500 leads in one request |
GET | /lead/import | List imports |
POST | /lead/import | Create an import from an uploaded file |
DELETE | /lead/import | Delete imports |
GET | /lead/import/:id | Get one import with progress |
PUT | /lead/import/:id | Update or resume an import |
POST | /lead/lead-gen-ai | Start an AI lead-generation run |
Same shape as leads. See the Contacts guide.
| Method | Endpoint | Description |
|---|
GET | /contact | List contacts |
POST | /contact | Create a contact |
PUT | /contact | Update many contacts |
DELETE | /contact | Delete contacts (soft) |
GET | /contact/:id | Get one contact |
PUT | /contact/:id | Update contact |
POST | /contact/bulk | Create up to 500 contacts in one request |
GET | /contact/import | List imports |
POST | /contact/import | Create an import from an uploaded file |
DELETE | /contact/import | Delete imports |
GET | /contact/import/:id | Get one import with progress |
PUT | /contact/import/:id | Update or resume an import |
| Method | Endpoint | Description |
|---|
GET | /contact-category | Get all contact category |
POST | /contact-category | Create contact category |
GET | /contact-category/:id | Get contact category |
PUT | /contact-category/:id | Update contact category |
| Method | Endpoint | Description |
|---|
GET | /tag | Get all tag |
POST | /tag | Create tag |
GET | /tag/:id | Get tag |
PUT | /tag/:id | Update tag |
Teams
| Method | Endpoint | Description |
|---|
GET | /team | Get all team |
POST | /team | Create team |
GET | /team/:id | Get team |
PUT | /team/:id | Update team |
Segments
| Method | Endpoint | Description |
|---|
GET | /segment | Get all segment |
POST | /segment | Create segment |
DELETE | /segment | Delete segment |
GET | /segment/:id | Get segment |
PUT | /segment/:id | Update segment |
GET | /segment/execute | Resolve a segment to a count |
Products & services
| Method | Endpoint | Description |
|---|
GET | /product-service | Get all product service |
POST | /product-service | Create product service |
PUT | /product-service | Bulk update product service |
GET | /product-service/:id | Get product service |
PUT | /product-service/:id | Update product service |
Lead activity & follow-ups
| Method | Endpoint | Description |
|---|
GET | /lead-activity | Get all lead activities |
GET | /lead-activity/:id | Get lead activity |
PATCH | /lead-activity/:id/notes | Update lead activity notes |
GET | /lead-activity/follow-up | Get follow ups |
POST | /lead-activity/follow-up | Create follow up |
PATCH | /lead-activity/follow-up/:id | Update follow up |
Call logs
| Method | Endpoint | Description |
|---|
GET | /calllog | Get all call logs |
POST | /calllog | Create call log |
DELETE | /calllog | Delete call log |
GET | /calllog/:id | Get call log |
PUT | /calllog/:id | Update call log |
POST | /calllog/bulk | Bulk create call log |
Meetings
| Method | Endpoint | Description |
|---|
GET | /meeting | Get all meetings |
POST | /meeting | Create meeting |
GET | /meeting/:id | Get meeting |
Custom fields
| Method | Endpoint | Description |
|---|
GET | /custom-field | Get all custom field |
POST | /custom-field | Create custom field |
DELETE | /custom-field | Delete custom field |
GET | /custom-field/:id | Get custom field |
PUT | /custom-field/:id | Update custom field |
PUT | /custom-field/modify | Modify fields |
PUT | /custom-field/reorder | Reorder fields |
PUT | /custom-field/reset-system | Reset system fields |
Custom sections
| Method | Endpoint | Description |
|---|
GET | /custom-section | Get all custom section |
POST | /custom-section | Create custom section |
DELETE | /custom-section | Delete custom section |
GET | /custom-section/:id | Get custom section |
PUT | /custom-section/:id | Update custom section |
PUT | /custom-section/reorder | Reorder sections |
77 endpoints in this section.