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

credentials = base64(“mywebsite:s3cret”)

and the HTTP header will look like:

Authorization: Basic bXl3ZWJzaXRlOnMzY3JldA==

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/

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.

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 bellow 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

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

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

• 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

Here is an example code in Python to send a new lead

import json
import requests
 
# There are your credentials are provided by us
USERNAME = 'mywebsite'
PASSWORD = 's3cret'
 
# Credentials are provided using HTTP Basic Auth ('Authorization' header)
auth = requests.auth.HTTPBasicAuth(USERNAME, PASSWORD)
 
# Each Real Geeks client has a unique identifier, Use this identifier
# to specify which client will receive this Lead inside Real Geeks
SITE_UUID = '106994a2-ad21-4ab7-ad89-1c4ccd9ae8a5'
 
# Each Real Geeks client has a specific URL to receive leads, based on the
# Site UUID
url = 'http://receivers.leadrouter.realgeeks.com/rest/sites/'+SITE_UUID+'/leads'
 
# Lead format in JSON, see documentation for all supported fields
lead = {
    "source": "My Website",
    "email": "jack@gmail.com",
    "first_name": "Jack",
    "last_name": "Johnson",
    "role": "Buyer",
    "phone": "808-123-1234",
    "created": "2015-04-01T08:41:51+00:00",
    "activities": [
        {
            "type": "contact_emailed",
            "description": "Hi, I'm interested in buying a house in Hawaii",
            "created": "2015-04-01T08:55:55+00:00",
        },
        {
            "type": "property_viewed",
            "description": "I'd like to visit this house",
            "property": {
                "mls": "12345",
                "url": "http://www.site.com/property/123",
                "street_address": "123 Keolu Dr",
                "city": "Kailua",
                "state": "HI",
                "zip": "96734",
                "beds": 2,
                "full_baths": 3,
                "half_baths": "1",
                "type": "Condo",
                "sqft": "1340",
                "listing_price": "100500",
                "listing_status": "For Sale",
                "listing_days_on_market": 10,
                "estimated_value": "145000",
                "last_sold_date": "2015-12-25",
                "last_sold_price": "25000.99",
                "tags": ["kailua","oahu","12345"],
                "latitude": 21.29242539,
                "longitude": -157.8501134,
            }
        },
    ]
}
 
# Request body has to be in JSON format
body = json.dumps(lead)
 
resp = requests.post(url, data=body, auth=auth)
 
print(resp)
print(resp.text)