Skip to main content

AI CRM chat

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

8 endpoints.

GET /ai-crm-chat

List ai crm chats.

Auth apikey

:::note Used by the web app pages/AiCrmChat.jsx :::

Query parameters

FieldDefault
p1
n30
searchValue

Responsedata is an array of AiCrmChat objects, alongside the pagination fields described in Response format. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /ai-crm-chat

Create ai crm chat.

Auth apikey · Success 201

:::note Used by the web app pages/AiCrmChat.jsx :::

Responsedata is one AiCrmChat object.

GET /ai-crm-chat/:id

Get ai crm chat.

Auth apikey

:::note Used by the web app components/CustomFieldsBasedForm.jsx, pages/ImportBulkMapping.jsx :::

Path parameters

Name
idRequired

Responsedata is one AiCrmMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

PUT /ai-crm-chat/:id

Update ai crm chat.

Auth apikey · Success 200

:::note Used by the web app components/CustomFieldsBasedForm.jsx, pages/ImportBulkMapping.jsx :::

Path parameters

Name
idRequired

DELETE /ai-crm-chat/:id

Delete ai crm chat.

Auth apikey · Success 200

:::note Used by the web app components/CustomFieldsBasedForm.jsx, pages/ImportBulkMapping.jsx :::

Path parameters

Name
idRequired

POST /ai-crm-chat/:id/message

Send ai crm chat message.

Auth apikey

:::note Used by the web app components/ViewImport.jsx, pages/ImportBulkMapping.jsx :::

Path parameters

Name
idRequired

Responsedata is one AiCrmChat object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors InvalidRequest_400 · PlanLimitExceeded_403

POST /ai-crm-chat/:id/tool/:messageId/:callId

Approve or reject a write the AI proposed.

Auth apikey

Path parameters

Name
idRequired
messageIdRequired
callIdRequired

Responsedata is one ResponseMessage object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors InvalidRequest_400 · NotFound_404

GET /ai-crm-chat/usage

Get ai crm chat usage.

Auth apikey