Skip to main content
POST
Submit a lead to Superior Van for processing. The response returns a leadId you can use to query status.

​
Required fields

A create lead request must include:
last_name is optional. A request may include only email, only phone, or both. Requests with neither email nor phone return 400.

​
Phone validation

Phone numbers may be formatted with spaces, hyphens, parentheses, or a leading +1. The API normalizes phone numbers by removing non-digits. Accepted phone values:
If phone is provided and does not meet this rule, the request returns 400.

​
ZIP handling

zip is optional. If provided, it is saved on the HubSpot contact only. It is not saved on the deal. If an existing contact is found and their ZIP is blank, the API updates the contact ZIP. Existing contact ZIP values are not overwritten.

​
Deal type

deal_type is required and must be one of:
The API does not default deal_type. Use other when the lead type does not fit another option.

Authorizations

​
x-api-key
string
header
required

API key issued to your vendor account

Body

application/json

Lead payload. Send as application/json. Must include either email or phone.

​
first_name
string
required

Customer first name. Required.

Minimum string length: 1
​
email
string<email>
required

Customer email address. Required when phone is not provided.

​
deal_type
enum<string>
required

Type of deal. Required. Allowed values are case-insensitive. The API does not default deal_type.

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

Vendor company name. Required.

Minimum string length: 1
​
lead_notes
string
required

Additional notes about the lead. Required. Supports multi-line text. If deal_type is other, the API prepends Needs Deal Type. to the notes.

Minimum string length: 1
​
last_name
string

Customer last name. Optional.

​
phone
string

Customer phone number. Required when email is not provided. Must contain 10 digits, or 11 digits starting with 1. Formatting characters such as spaces, hyphens, parentheses, and a leading + are allowed.

​
zip
string

Customer ZIP code. Optional. Saved to the HubSpot contact only, not the deal. Existing contact ZIP values are not overwritten.

​
external_lead_id
string

Vendor's internal lead ID for reference. Optional.

​
external_id
string

Legacy vendor internal ID. Optional. If both external_id and external_lead_id are provided, external_lead_id takes precedence.

​
vehicle_year
string

Vehicle model year. Optional.

​
vehicle_make
string

Vehicle make. Optional.

​
vehicle_model
string

Vehicle model. Optional.

​
vehicle_miles
string

Vehicle mileage. Optional.

Response

Lead accepted

​
statusCode
integer
required
Example:

200

​
body
object
required