Lead
Create a Lead
POST /v1/leads
Body Parameters
The request has the following parameters in body:
| Parameter | Description | |
|---|---|---|
| name | The name of the lead | Required |
| The email of the lead | Required | |
| phone | The phone of the lead | Optional |
| broker_channel_id | The ID of the broker product | Optional |
| broker_product_id | The ID of the broker product | Optional |
{
"name": "string",
"email": "string",
"phone": "string",
"broker_channel_id": "string",
"broker_product_id": "string"
}
Response
The above request returns JSON structured like this:
| Parameter | Description |
|---|---|
| id | The ID of the lead |
{
"id": "string"
}
List Leads
GET /v1/leads
URL Parameters
| Parameter | Description | |
|---|---|---|
| rows | A limit of objects to be returned, between 1 and 100 items | Optional |
| page | The page for the list of objects to return | Optional |
| cursor | The cursor of the current page list of objects | Optional |
Response
The above request returns JSON structured like this:
| Parameter | Description |
|---|---|
| total | The total of items |
| items.id | The ID of the lead |
| items.name | The name of the lead |
| items.email | The email of the lead |
| items.phone | The phone of the lead |
| items.broker_channel_id | The ID of the broker product |
| items.broker_product_id | The ID of the broker product |
{
"total": 0,
"items": [
{
"id": "string",
"name": "string",
"email": "string",
"phone": "string",
"broker_channel_id": "string",
"broker_product_id": "string"
}
]
}