POST
/
leads
Create a new Lead
curl --request POST \
  --url https://commerce.driv.ly/api/leads \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "led_3k2jd9s8v2s4",
  "email": "contact@example.com",
  "salesRep": "SalesRep ID",
  "consumer": "Consumer ID",
  "favorites": [
    "Vehicle ID Number"
  ],
  "phoneNumber": "555-6789",
  "acceptsGeneratedMessages": true
}'
{
  "data": {
    "id": "led_3k2jd9s8v2s4",
    "email": "contact@example.com",
    "salesRep": "SalesRep ID",
    "consumer": "Consumer ID",
    "favorites": [
      "Vehicle ID Number"
    ],
    "phoneNumber": "555-6789",
    "acceptsGeneratedMessages": true
  },
  "success": true
}

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
phoneNumber
string
required

Lead has Phone Number

email
string<idn-email>
required

Lead has Email

id
string

Lead is uniquely identified by id

salesRep

Sales Rep is assigned to Lead

consumer

Lead participates in transactions as Consumer

favorites
(string | Vehicle · object)[]

Lead favorites Vehicle

acceptsGeneratedMessages
boolean

Lead accepts generated messages

Response

Lead Created

data
object
Examples:
{
"id": "led_3k2jd9s8v2s4",
"email": "contact@example.com",
"salesRep": "SalesRep ID",
"consumer": "Consumer ID",
"favorites": ["Vehicle ID Number"],
"phoneNumber": "555-6789",
"acceptsGeneratedMessages": true
}
success
boolean