Both endpoints are authenticated by the key embedded in your Lead save URL
(Settings → Lead Management → Lead sources → URLs). Copy that URL from the CRM and replace the
trailing
/save with the path of the endpoint you need. The field-by-field reference is on the
Lead source API page.1. Save the lead
first_name, phone and one vehicle are required. A ZIP on each end is enough for the route;
BeRocker fills in the city and state.
The response gives you the lead’s id and the booking page:
422 means a field was rejected; errors names it with a message you can show under the field,
and no lead is saved.
2. Wait for the price — booking-status
Pricing runs in the background, so price is usually empty right after the save. If you want to
send the customer straight to the booking page with a price on it, poll:
priceReady: true— send them tobookingLink.manualReview: true— the lead has a custom vehicle; an agent prices it by hand. Stop polling and show your own “we’ll be in touch with your quote” message.priceFailed: true— pricing gave up. Same: stop and show a message.
3. Hand off to the booking page
Send the customer tobookingLink. The booking page opens on the pickup date they gave you, and
whatever they confirm there — dates, signature, payment — flows into the lead exactly as it would
for a widget lead.
Editions with pickup windows
Some BeRocker editions let a form ask for a pickup window (a first and last day) or a pickup timeframe (“how soon do you need it?”) instead of a single date, and expose aquote-config
endpoint that tells the form which question the account asks. If your CRM has a
Settings → Feature Flags page with a Pickup windows switch, read
Lead Source API with pickup windows. If it does not, your edition
takes the single ship_date above and nothing on that page applies.
Checklist
1
Copy your Lead save URL
Settings → Lead Management → Lead sources → URLs. Create a separate source for the form if you
want its leads and cost tracked separately.
2
Post to /save
Required:
first_name, phone, one vehicle. Handle a 422 by showing the field message.3
Poll booking-status, then hand off
Send the customer to
bookingLink once priceReady is true.4
Send one test lead
Use your own name and number and watch it land in Inbox.
Related
Lead source API
Every field the save endpoint accepts.
Vehicle database API
Year, make and model pickers backed by the widget’s catalogue.
Lead sources
Create the source and get the URL.
Lead Source API with pickup windows
Optional pickup fields, for editions that have them.
Booking page
Where the customer confirms dates, signs and pays.