Send leads (Follow Up Boss-compatible)
Send leads with the same payload you send Follow Up Boss, or from a website form. They run through routing, tagging and follow-up like
POST /events takes Follow Up Boss’s event payload. Send leads to Broker & Agent the way you send them to Follow Up Boss: the same request, with our URL and key. Many lead vendors send only to Follow Up Boss’s own address, so this works where your lead source lets you set the address, like custom forms, ISA tools and
A lead sent this way takes the same path as a lead from your website: it’s matched to an existing contact by email, routed by your lead rules, tagged with its source, and started on
Send a lead#
curl -X POST https://workspace.brokerandagent.com/api/public/v1/events \
-H "Authorization: Bearer bak_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "Zillow Flex",
"type": "Inquiry",
"message": "Wants to see 41 Oak St this weekend",
"person": {
"firstName": "Dana", "lastName": "Reyes",
"emails": [{ "value": "dana@example.com" }],
"phones": [{ "value": "(816) 555-0100" }],
"tags": ["relocation"]
},
"property": { "street": "41 Oak St", "city": "Kansas City", "state": "MO" }
}'A person needs at least a name, an email
| Answer | When |
|---|---|
201 with the contact |
A new contact was created |
200 with the contact |
The email matched an existing contact; the inquiry lands on their timeline |
202 { "ok": true } |
The key is a lead-capture key (Leads in only), or the match is a contact this key’s person can’t see. The lead still lands |
422 |
There’s no name, email or phone |
The property’s city and price reach your lead rules, so a rule’s Only when conditions (area and price) work on
Give each lead source its own Leads in only key. It can send leads and read nothing, so a leaked key can’t expose your book. See Authentication.
Coming from Follow Up Boss#
Only lead intake carries over. Here’s what a lead source that already sends to Follow Up Boss
- The key. Use one of ours; a Leads in only key is best. Follow Up Boss’s Basic auth works as it is, with our key as the username and
an empty password. - The full address. Send to
https://workspace.brokerandagent.com/api/public/v1/events. There’s no short/v1/eventsaddress onan API host. - The answer. We answer with
{ contactId, created, contact }, not Follow Up Boss’s person object with a numeric id. Anything that reads the answer needsto read ours. - The other calls.
/people,/notes,/callsand/dealsin Follow Up Boss’s shape don’t exist here. Our contacts, tasks, appointments and transactions calls havetheir own shapes.
What carries over#
| Field | Carries over |
|---|---|
source (or system), type, message |
Yes |
person: names, emails, phones |
Yes |
person.tags |
Yes, up to 10 |
property: street, city, state, price, MLS number and URL |
Yes |
| Zip and the other property fields | No |
| Person stage, assignee and addresses | No |
campaign, occurredAt |
No |
X-System headers |
Ignored |
Event types#
- A seller type (anything with “seller”, “home value” or “CMA”) marks the lead as selling. Rentals and leases are read from the type and message. Everything else
is a buyer. - Activity types (
Viewed Property,Viewed Page,Visited Website,Saved Property,Property Search,Saved Property Search) land on thetimeline as activity. Unsubscribedopts an email out. It needs thecrm.writescope and only affects a contact the credential’sperson can see.
The same inquiry from the same person within 10 minutes adds no second note and sends
Website form leads#
POST /site-leads takes one form submission from a website’s server. It’s what Broker & Agent websites send, with a lead-capture key, and any website can use it. The key
{
"source": "agent-site",
"lead": {
"name": "Rosa Diaz", "email": "rosa@example.com", "phone": "941-555-0177",
"interest": "Buying", "message": "Can I see it this weekend?",
"pageUrl": "https://example.com/homes/123?utm_source=google",
"formSource": "listing-inquiry", "consent": true,
"submissionId": "b1f0c…", "visitorId": "v_…", "intent": "buy",
"listing": { "mlsId": "A4612345", "address": "123 Main St", "city": "Sarasota",
"state": "FL", "zip": "34236", "price": 450000,
"url": "https://example.com/homes/123", "lease": false }
}
}intentisbuy,sell,rent,bothorowner. Without it,interestis read. An owner (property management) arrives taggedproperty-owner.- UTM tags come from
pageUrl, and the listing lands onthe lead’s note. visitorIdties the visitor’s earlier browsing and chat on the siteto the lead. consent: truewith a phone keeps a record that the visitor agreed to texts: the form’s wording, thepage and when. submissionIdis the deduplication key, kept 30 days, so a retry lands once. A copy that arrives while the first is still being handled may get409 in_progresswithRetry-After.- The answer is
200 { "id": "<contactId>", "created": true | false }. A lead-capture key gets{ "id": null, "created": null }. A lead with no name, email or phone is422.
A site can also send its leads with POST /events or POST /contacts and
Related#
- Retrying safely
- Webhooks: get
lead.createdthe momenta lead lands.
Something missing or wrong? Email support@brokerandagent.com and