Leads

Get all leads for a specific chatflow

get

Retrieve all leads associated with a specific chatflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Chatflow ID

Responses

200

Successful operation

application/json

idstring · uuidOptional

Unique identifier for the lead

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

namestringOptional

Name of the lead

Example: John Doe

emailstringOptional

Email address of the lead

Example: [e-mail]

phonestringOptional

Phone number of the lead

Example: [phone]

chatflowidstringOptional

ID of the chatflow the lead is associated with

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

chatIdstringOptional

ID of the chat session the lead is associated with

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

createdDatestring · date-timeOptional

Date and time when the lead was created

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

400

Invalid ID provided

404

Leads not found

500

Internal server error

get/leads/{id}

GET /leads/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create a new lead in a chatflow

post

Create a new lead associated with a specific chatflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstring · uuidOptional

Unique identifier for the lead

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

namestringOptional

Name of the lead

Example: John Doe

emailstringOptional

Email address of the lead

Example: [e-mail]

phonestringOptional

Phone number of the lead

Example: [phone]

chatflowidstringOptional

ID of the chatflow the lead is associated with

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

chatIdstringOptional

ID of the chat session the lead is associated with

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

createdDatestring · date-timeOptional

Date and time when the lead was created

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

Responses

200

Lead created successfully

application/json

idstring · uuidOptional

Unique identifier for the lead

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

namestringOptional

Name of the lead

Example: John Doe

emailstringOptional

Email address of the lead

Example: [e-mail]

phonestringOptional

Phone number of the lead

Example: [phone]

chatflowidstringOptional

ID of the chatflow the lead is associated with

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

chatIdstringOptional

ID of the chat session the lead is associated with

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

createdDatestring · date-timeOptional

Date and time when the lead was created

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

400

Invalid request body

422

Validation error

500

Internal server error

post/leads

POST /leads HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 253

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

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