Skip to main content

CRM

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.

MethodEndpointDescription
GET/leadList leads
POST/leadCreate a lead
PUT/leadUpdate many leads
DELETE/leadDelete leads (soft)
GET/lead/:idGet one lead
PUT/lead/:idUpdate lead
POST/lead/bulkCreate up to 500 leads in one request
GET/lead/importList imports
POST/lead/importCreate an import from an uploaded file
DELETE/lead/importDelete imports
GET/lead/import/:idGet one import with progress
PUT/lead/import/:idUpdate or resume an import
POST/lead/lead-gen-aiStart an AI lead-generation run

Contacts

Same shape as leads. See the Contacts guide.

MethodEndpointDescription
GET/contactList contacts
POST/contactCreate a contact
PUT/contactUpdate many contacts
DELETE/contactDelete contacts (soft)
GET/contact/:idGet one contact
PUT/contact/:idUpdate contact
POST/contact/bulkCreate up to 500 contacts in one request
GET/contact/importList imports
POST/contact/importCreate an import from an uploaded file
DELETE/contact/importDelete imports
GET/contact/import/:idGet one import with progress
PUT/contact/import/:idUpdate or resume an import

Contact categories

MethodEndpointDescription
GET/contact-categoryGet all contact category
POST/contact-categoryCreate contact category
GET/contact-category/:idGet contact category
PUT/contact-category/:idUpdate contact category

Tags

MethodEndpointDescription
GET/tagGet all tag
POST/tagCreate tag
GET/tag/:idGet tag
PUT/tag/:idUpdate tag

Teams

MethodEndpointDescription
GET/teamGet all team
POST/teamCreate team
GET/team/:idGet team
PUT/team/:idUpdate team

Segments

MethodEndpointDescription
GET/segmentGet all segment
POST/segmentCreate segment
DELETE/segmentDelete segment
GET/segment/:idGet segment
PUT/segment/:idUpdate segment
GET/segment/executeResolve a segment to a count

Products & services

MethodEndpointDescription
GET/product-serviceGet all product service
POST/product-serviceCreate product service
PUT/product-serviceBulk update product service
GET/product-service/:idGet product service
PUT/product-service/:idUpdate product service

Lead activity & follow-ups

MethodEndpointDescription
GET/lead-activityGet all lead activities
GET/lead-activity/:idGet lead activity
PATCH/lead-activity/:id/notesUpdate lead activity notes
GET/lead-activity/follow-upGet follow ups
POST/lead-activity/follow-upCreate follow up
PATCH/lead-activity/follow-up/:idUpdate follow up

Call logs

MethodEndpointDescription
GET/calllogGet all call logs
POST/calllogCreate call log
DELETE/calllogDelete call log
GET/calllog/:idGet call log
PUT/calllog/:idUpdate call log
POST/calllog/bulkBulk create call log

Meetings

MethodEndpointDescription
GET/meetingGet all meetings
POST/meetingCreate meeting
GET/meeting/:idGet meeting

Custom fields

MethodEndpointDescription
GET/custom-fieldGet all custom field
POST/custom-fieldCreate custom field
DELETE/custom-fieldDelete custom field
GET/custom-field/:idGet custom field
PUT/custom-field/:idUpdate custom field
PUT/custom-field/modifyModify fields
PUT/custom-field/reorderReorder fields
PUT/custom-field/reset-systemReset system fields

Custom sections

MethodEndpointDescription
GET/custom-sectionGet all custom section
POST/custom-sectionCreate custom section
DELETE/custom-sectionDelete custom section
GET/custom-section/:idGet custom section
PUT/custom-section/:idUpdate custom section
PUT/custom-section/reorderReorder sections

77 endpoints in this section.