Skip to main content
POST
/
lead
/
add
Add new lead with mobile.
curl --request POST \
  --url https://apigw.bienport.com/api/lead/add \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Test3 Name",
  "prospectContact": [
    {
      "characteristic": {
        "city": "İstanbul",
        "phoneNumber": "5XXXXXXXXXX (phoneNumber must be 10 characters. phoneNumber must not be start 0.)",
        "mobileAppId": "1231-4654-6564-6498-99",
        "subscriptionId": "551",
        "panelNo": "EA-560"
      }
    }
  ]
}'
{
  "id": 89839,
  "totalPages": 1,
  "href": "FN-3***",
  "totalItems": 1,
  "creationDate": "2020-07-06T00:00:00.000Z",
  "currentPage": 1,
  "description": "****",
  "leads": [
    {}
  ],
  "name": "KAMER T****",
  "rating": 50,
  "referredDate": "2020-07-06T00:00:00.000Z",
  "category": {
    "id": 123,
    "name": "Alarm"
  },
  "marketSegment": {
    "id": 1,
    "name": "Alarm"
  },
  "prospectContact": [
    {
      "characteristic": {
        "city": "İstanbul",
        "phoneNumber": "5XXXXXXXXXX (phoneNumber must be 10 characters. phoneNumber must not be start 0.)",
        "mobileAppId": "1231-4654-6564-6498-99",
        "subscriptionId": "551",
        "panelNo": "EA-560"
      }
    }
  ],
  "relatedParty": [
    {
      "id": "456789",
      "name": "<string>"
    }
  ],
  "status": "Randevu Alındı"
}

Body

application/json

addLeadRequest

Request Model for add lead

name
string
required

Customer Name

Example:

"Test3 Name"

prospectContact
ProspectContact · object[]

Response

Lead Adding Success.

Response Model for get lead

id
integer
Example:

89839

totalPages
integer
Example:

1

href
string
Example:

"FN-3***"

totalItems
integer
Example:

1

creationDate
string
Example:

"2020-07-06T00:00:00.000Z"

currentPage
integer
Example:

1

description
string
Example:

"****"

leads
GetLeadResponse · object[]
name
string
Example:

"KAMER T****"

rating
integer
Example:

50

referredDate
string
Example:

"2020-07-06T00:00:00.000Z"

category
object

Category for get lead

marketSegment
object

MarketSegment for get lead

prospectContact
ProspectContact · object[]
status
string
Example:

"Randevu Alındı"