Skip to main content
POST
Create a new Lead

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})$
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
Lead · object
Example:
success
boolean