Create a new Lead - Drivly Docs

curl --request POST \ --url https://commerce.driv.ly/api/leads \ --header 'Content-Type: application/json' \ --data ' { "phoneNumber": "<string>", "email": "<string>", "id": "<string>", "salesRep": "<string>", "consumer": "<string>", "favorites": [ "<string>" ], "acceptsGeneratedMessages": true } '

{ "data": { "id": "<string>", "phoneNumber": "<string>", "email": "<string>", "salesRep": "<string>", "consumer": "<string>", "favorites": [ "<string>" ], "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

Pattern: ^\+?1?[- ]?$?([0-9]{3})$?[- ]?([0-9]{3})-?([0-9]{4})$

string<idn-email>

required

Lead has Email

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

Lead · object

Show child attributes

Example:

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

success

boolean