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": "John",
  "last_name": "Doe",
  "email": "customer@example.com",
  "phone": "502-555-1234",
  "deal_type": "sales",
  "vendor_name": "ABC Vendor",
  "lead_notes": "Customer interested in new van\nFollow up next week"
}
'
{
  "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

​
deal_type
enum<string>
required

Type of deal. Maps to HubSpot dealtype property. Allowed values (case-insensitive): sales → newbusiness, service → existingbusiness, rental → Rental, lift → Lift, commercial → Commercial, buy-back → Buy-Back, other → Other. Returns 400 if missing, empty, or invalid.

Available options:
sales,
service,
rental,
lift,
commercial,
buy-back,
other
​
vendor_name
string
required

Vendor company name. Maps to HubSpot vendor_name property. Required field. Returns 400 if missing or empty.

​
lead_notes
string
required

Additional notes about the lead. Maps to HubSpot lead_notes property. Supports multi-line text. Required field. If deal_type is 'other', automatically prepends 'Needs Deal Type. ' to the notes. Returns 400 if missing, null, or empty.

​
external_lead_id
string

Vendor's internal lead ID for reference and future searches. Maps to HubSpot external_lead_id property. Optional field.

​
external_id
string

Unique vendor internal ID for the lead in their system

​
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