Leads

PreviousFeedback NextPing

Last updated 28 days ago

Get all leads for a specific chatflow

Retrieve all leads associated with a specific chatflow

get

/leads/{id}

Authorizations

Path parameters

idstringrequired

Chatflow ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/leads/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "chatflowid": "7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02",
    "chatId": "d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b",
    "createdDate": "2024-08-24T14:15:22Z"
  }
]

Successful operation

Create a new lead in a chatflow

Create a new lead associated with a specific chatflow

post

/leads

Authorizations

Body

idstring · uuid

Unique identifier for the lead

Example: cfd531e0-82fc-11e9-bc42-526af7764f64

namestring

Name of the lead

Example: John Doe

emailstring

Email address of the lead

Example: john.doe@example.com

phonestring

Phone number of the lead

Example: +1234567890

chatflowidstring

ID of the chatflow the lead is associated with

Example: 7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02

chatIdstring

ID of the chat session the lead is associated with

Example: d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b

createdDatestring · date-time

Date and time when the lead was created

Example: 2024-08-24T14:15:22Z