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",
"email": "customer@example.com",
"phone": "502-555-1234",
"deal_type": "sales",
"vendor_name": "ABC Vendor",
"lead_notes": "Customer interested in a new van. Follow up next week."
}
'{
"statusCode": 200,
"body": {
"leadId": "61364584065"
}
}Create Lead
Submit a lead for Superior Van to process. A request must include first_name, deal_type, vendor_name, lead_notes, and either email or phone.
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",
"email": "customer@example.com",
"phone": "502-555-1234",
"deal_type": "sales",
"vendor_name": "ABC Vendor",
"lead_notes": "Customer interested in a new van. Follow up next week."
}
'{
"statusCode": 200,
"body": {
"leadId": "61364584065"
}
}leadId you can use to query status.
Required fields
A create lead request must include:first_name
deal_type
vendor_name
lead_notes
email OR phone
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:
10 digits
11 digits starting with 1
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:
sales
service
rental
lift
commercial
buy-back
other
deal_type. Use other when the lead type does not fit another option.Authorizations
API key issued to your vendor account
Body
- Option 1
- Option 2
Lead payload. Send as application/json. Must include either email or phone.
Customer first name. Required.
1Customer email address. Required when phone is not provided.
Type of deal. Required. Allowed values are case-insensitive. The API does not default deal_type.
sales, service, rental, lift, commercial, buy-back, other Vendor company name. Required.
1Additional notes about the lead. Required. Supports multi-line text. If deal_type is other, the API prepends Needs Deal Type. to the notes.
1Customer last name. Optional.
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.
Customer ZIP code. Optional. Saved to the HubSpot contact only, not the deal. Existing contact ZIP values are not overwritten.
Vendor's internal lead ID for reference. Optional.
Legacy vendor internal ID. Optional. If both external_id and external_lead_id are provided, external_lead_id takes precedence.
Vehicle model year. Optional.
Vehicle make. Optional.
Vehicle model. Optional.
Vehicle mileage. Optional.