Leads API
Send enquiries (leads) from your website or app into FeedSync. Requires a key with the leads:write scope.
Submit a lead
curl -X POST https://feedsync.com.au/api/v1/leads \
-H "Authorization: Bearer fs_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Buyer",
"email": "jane@example.com",
"phone": "0400 000 000",
"message": "Is this property still available?",
"type": "inquiry",
"listing_ref": 1234
}'
Request body
| Field | Required | Notes |
|---|---|---|
name | ✅ | The enquirer's name. |
email / phone / mobile | ✅* | At least one contact method is required. |
message | — | The enquiry text. |
type | — | inquiry, appraisal, rental_application, or general. |
priority | — | hot, warm, or cold. |
listing_ref | — | The listing's numeric ref, if the enquiry is about a property. |
listing_id | — | Alternatively, the listing's string id. |
agent_email | — | Route the lead to a specific agent. |
metadata | — | Any extra key/value data you want to attach. |
Response
On success you'll receive 201 Created:
{
"lead_id": 9876,
"status": "new",
"duplicate": false,
"assigned_to": "agent@agency.com.au"
}
duplicate is true if FeedSync detected the same enquiry was already submitted recently.
Errors
- 422 — validation failed (e.g. no contact method):
{ "error": { "code": "VALIDATION_ERROR", "details": { … } } } - 403 — the key is missing the
leads:writescope.