Skip to main content
POST
/
lead
Create lead
curl --request POST \
  --url https://api.superiorvan.com/v1/lead \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "first_name": "Alex",
  "last_name": "Rivers",
  "email": "[email protected]",
  "phone": "502-555-1234"
}
'
{
  "leadId": "<string>",
  "status": "received"
}
Send an ADF-formatted lead (as JSON) to Superior Van for processing. The response returns a leadId you can use to query status.

Authorizations

​
x-api-key
string
header
required

API key issued to your vendor account

Body

application/json

ADF lead payload. Send as application/json.

​
first_name
string
required

Customer first name

​
last_name
string
required

Customer last name

​
email
string<email>
required

Customer email address

​
phone
string
required

Customer phone number

​
lead_type
enum<string>

Type of lead. Accepts both capitalized and lowercase values (e.g., 'Sales' or 'sales'). Defaults to 'Other' if not provided.

Available options:
Sales,
Service,
Rental,
Lift,
Commercial,
Buy-Back,
Other
​
vendor_name
string

Vendor company name

​
external_id
string

Unique vendor internal ID for the lead in their system

​
lead_notes
string

Additional notes about the lead

​
vehicle_year
string

Vehicle model year

​
vehicle_make
string

Vehicle make

​
vehicle_model
string

Vehicle model

​
vehicle_miles
string

Vehicle mileage

Response

Lead accepted

​
leadId
string

Assigned lead id

​
status
enum<string>

Initial status of the lead

Available options:
received