Leads
GET
/leads/{id}
Get all leads for a specific chatflow
Retrieve all leads associated with a specific chatflow
<div class="api-params-section"><h4>Path Parameters</h4><table class="api-params-table"><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td><code>string</code></td><td><span class="req-yes">Yes</span></td><td>Chatflow ID</td></tr></tbody></table></div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Successful operation</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-property-array">Array of: <div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the lead</div>
<div class="api-property-example">Example: <code>"cfd531e0-82fc-11e9-bc42-526af7764f64"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the lead</div>
<div class="api-property-example">Example: <code>"John Doe"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">email</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Email address of the lead</div>
<div class="api-property-example">Example: <code>"john.doe@example.com"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">phone</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Phone number of the lead</div>
<div class="api-property-example">Example: <code>"+1234567890"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatflowid</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chatflow the lead is associated with</div>
<div class="api-property-example">Example: <code>"7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chat session the lead is associated with</div>
<div class="api-property-example">Example: <code>"d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the lead was created</div>
<div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
</div>
</div></div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid ID provided</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">404</span>
<span class="api-response-desc">Leads not found</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>
POST
/leads
Create a new lead in a chatflow
Create a new lead associated with a specific chatflow
<div class="api-body-section">
<div class="api-request-body-section">
<h4>Request Body (application/json)</h4>
<div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the lead</div>
<div class="api-property-example">Example: <code>"cfd531e0-82fc-11e9-bc42-526af7764f64"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the lead</div>
<div class="api-property-example">Example: <code>"John Doe"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">email</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Email address of the lead</div>
<div class="api-property-example">Example: <code>"john.doe@example.com"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">phone</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Phone number of the lead</div>
<div class="api-property-example">Example: <code>"+1234567890"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatflowid</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chatflow the lead is associated with</div>
<div class="api-property-example">Example: <code>"7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chat session the lead is associated with</div>
<div class="api-property-example">Example: <code>"d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the lead was created</div>
<div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
</div>
</div>
</div>
</div>
<div class="api-responses-section"><h4>Responses</h4><div class="api-responses-list">
<div class="api-response-row">
<span class="api-response-code code-success">200</span>
<span class="api-response-desc">Lead created successfully</span>
<div class="api-response-schema-toggle">Schema Detail:</div><div class="api-object-properties">
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">id</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Unique identifier for the lead</div>
<div class="api-property-example">Example: <code>"cfd531e0-82fc-11e9-bc42-526af7764f64"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">name</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Name of the lead</div>
<div class="api-property-example">Example: <code>"John Doe"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">email</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Email address of the lead</div>
<div class="api-property-example">Example: <code>"john.doe@example.com"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">phone</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Phone number of the lead</div>
<div class="api-property-example">Example: <code>"+1234567890"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatflowid</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chatflow the lead is associated with</div>
<div class="api-property-example">Example: <code>"7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">chatId</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">ID of the chat session the lead is associated with</div>
<div class="api-property-example">Example: <code>"d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b"</code></div>
</div>
<div class="api-property-row" style="margin-left: 0px;">
<div class="api-property-meta">
<span class="api-property-name">createdDate</span>
<span class="api-property-type">string</span>
<span class="api-property-optional">optional</span>
</div>
<div class="api-property-desc">Date and time when the lead was created</div>
<div class="api-property-example">Example: <code>"2024-08-24T14:15:22Z"</code></div>
</div>
</div>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">400</span>
<span class="api-response-desc">Invalid request body</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">422</span>
<span class="api-response-desc">Validation error</span>
</div>
<div class="api-response-row">
<span class="api-response-code code-error">500</span>
<span class="api-response-desc">Internal server error</span>
</div>
</div></div>
</div>