Other products can send leads to Lead Manager using our Incoming Leads API. This documentation is for developers looking to integrate with Real Geeks.
Authentication
First the product has to be registered and a username and password will be provided, example:
- Username: mywebsite
- Password: s3cret
These credentials must be provided on all requests, using HTTP Basic Auth
and the HTTP header will look like:
Each product talking to Real Geeks has a single username and password, these credentials will be used to send leads to any Real Geeks client. Each Real Geeks client has a unique identifier called Site UUID, internally we know which clients a product has access to.
To obtain credentials send a message to https://www.realgeeks.com/support/
Endpoints
We allow leads to be created, updated and activities to be added. An activity is anything a lead has done, like sent a contact message or viewed a property.
Base url: http://receivers.leadrouter.realgeeks.com/rest
all paths bellow should be appended to the url above.
POST /sites/<site_uuid>/leads
Create a new lead.
- site_uuid is the Client Identification inside Real Geeks.
This endpoint assumes the lead doesn't exist yet, but our Lead Manager might decide they already have this lead (based on email or name, for example) and update it.
See Lead Fields below for the supported fields for this request.
One of the fields is id, so if clients want to update or add activities to this lead later they should generate an id and send with this request. The only requirement is the id field needs to be a valid UUID string.
On success response has status 201 Created and empty json body {}. On error see Error Responses bellow
PATCH /sites/<site_uuid>/leads/<lead_id>
Update an existing lead. Where
- site_uuid is the Client Identification inside Real Geeks
- lead_id is the id of an existing lead
All fields are optional. Only fields that are present are updated. Fields that are not present are left alone.
All activities listed in the activities will be added to the existing lead, activities are never deleted.
See Lead Fields below for the supported fields for this request.
On success response has status 200 OK and empty body {}. On error see Error Responses below
POST /sites/<site_uuid>/leads/<lead_id>/activities
Add one or more activities to an existing lead.
site_uuid is the Client Identification inside Real Geeks
lead_id is the id of an existing lead
Request body is a list of objects where each object has Activity fields
On success response has status 200 OK and empty body {}. On error see Error Responses bellow
POST /sites/<site_uuid>/potential-seller-leads
site_uuid is the Client Identification inside Real Geeks
Create a Potential Seller Lead, an anonymous lead that has the potential to become a seller lead.
No contact information is available, no name, email or phone number. But it has at least one Activity of type property_viewed with a property field.
The supported fields is a small subset of the Leads fields:
- id
- activities
- created
See Leads fields and Activity fields bellow for details
On success response has status 201 Created and empty json body {}. On error see Error Responses bellow
Error responses
Tables can't be imported directly. Please insert an image of your table which can be found here.
Lead Fields
Tables can't be imported directly. Please insert an image of your table which can be found here.
Activity ActivityActivity fields
Tables can't be imported directly. Please insert an image of your table which can be found here.
Property PropertyProperty fields
Tables can't be imported directly. Please insert an image of your table which can be found here.
Example code
Here is an example code in Python to send a new lead
# Request body has to be in JSON format