v1
latestOpenAPI 3.0.12026-07-24501176.6 MBAssign Lead
Lets you change the owner of an existing lead.
Query parameters
Get leads of a specific customer. Pass the user ID of the customer.
Get leads of a specific status. Values: OPEN, ON_HOLD, WON, LOST, DELETED.
Get leads by lead sub-status.
Fetch leads assigned to a specific associate. Pass the associate/staff ID (user id of the staff).
Limit the number of results to retrieve.
Number of rows (as per the data entered into the table) that you want omit from showing.
Get leads of a specific entity. You also need to pass the entityCode accordingly. Pass entityType and e Values: ZONE, CONCEPT, STORE, TILL, STR_SERVER, ADMIN_USER, ASSOCIATE, STAFF.
Pass the code of the respective entityType. For example, if entityType is STORE, then entityCode should be store code by which you want to get leads.
Response
200
Example response
{
"data": [
{
"id": 3,
"userId": 90486448,
"type": "SKU",
"leadFor": "Denim",
"status": "ON_HOLD",
"nextFollowUp": "2018-10-05T02:30:00Z",
"createdOn": "2018-10-04T08:00:00Z",
"createdBy": 75029724,
"lastUpdatedOn": "2019-02-20T15:28:13Z",
"lastUpdatedBy": 75029724,
"followUpDetails": [
{
"id": 5,
"userId": 90486448,
"leadId": 3,
"notes": "notes 1",
"createdBy": 75029724,
"createdOn": "2019-02-20T15:28:13Z",
"followedUpBy": 75029724,
"followedUpOn": "2018-10-04T07:15:00Z",
"scheduledFollowUp": "2018-10-04T07:00:00Z"
}
],
"statusLogDetails": [
{
"id": 5,
"userId": 90486448,
"leadId": 3,
"status": "OPEN",
"createdBy": 75029724,
"createdOn": "2019-02-20T15:28:13Z",
"reasonId": 3,
"reason": "APICALL"
}
],
"orgSourceId": -1,
"extendedFields": {
"trial_status": "Not Done"
}
}
]
}