Website Leads API

Overview

If a prospective renter fills out a form on a building's website, you POST the form data to this endpoint. SeeClickRent will:

1. Create or look up the customer record (by email, then phone).
2. Create a new lead and attach it to the right building (using the token you send).
3. Notify the assigned leasing agent by email.

The response gives you back the new lead ID. There are no read endpoints — this API is write-only.

Authentication

There is no API key or bearer token. Each building has its own opaque token string, and you include it in the request body to associate the lead with that building.

• A SeeClickRent admin issues the token to you when your integration is set up.
• Treat the token like a shared secret — anyone with the token can post leads for that building.
• One token = one building. If you integrate multiple buildings, you'll receive one token per building.

If you're integrating a SeeClickRent-managed building website, the token is typically already embedded in the page by the time the form posts.

CORS

The endpoint accepts cross-origin browser requests from:

• The SeeClickRent domain itself.
• Any building's registered website URL (configured in SeeClickRent).

If you call the endpoint directly from a browser on a domain that hasn't been registered for any building, the request will be blocked by CORS. The allowlist is cached for up to 5 minutes after a building's website is added or changed.

If you call from a server (cURL, Python, Node backend, etc.), CORS does not apply.

Rate limits

• 300 requests per 5 minutes per source IP across the entire /api/* namespace.
• Excess requests get an HTTP 429 Too Many Requests with a Retry-After header (in seconds) and this body:

{
  "error": {
    "message": "throttled",
    "human_message": "Too many requests. Please try again later."
  }
}

If you anticipate higher volume from a single IP, contact SeeClickRent before going live.

Request

Headers

Content-Type: application/json
Accept: application/json

Body

All lead fields go inside a tour_request object. The building token (and a couple of optional building-lookup alternatives) live at the top level alongside it.

{
  "token": "abc123def456",
  "tour_request": {
    "requestor_name": "Jane Smith",
    "requestor_email": "jane@example.com",
    "requestor_phone": "+15551234567",
    "message": "Interested in 2-bedroom units, ideally for May 1st move-in.",
    "slot": "2026-05-15T14:00:00Z",
    "unit_preference": "2A",
    "utm_data": "utm_source=google&utm_medium=cpc&utm_campaign=spring2026",
    "listing_source": "nooklyn",
    "listing_source_original_id": "12345",
    "request_host": "https://example-building.com",
    "sms_consent": "true"
  }
}

Field reference

Top-level fields (used to identify the building)

The endpoint tries them in order: token → unified_address_id → address_line_one. If none match a known building, the lead is still created but will be unassigned (no agent will be notified). Always send token if you have it.

tour_request fields

Server-managed fields (do not send)

These are set automatically and cannot be overridden:

• lead_source is always set to website for this endpoint.
• property_type is set to listing if unit_preference is provided, otherwise building.

UTM tracking

Pass utm_data as a single URL-query-style string. The server splits and stores it as a JSON object on the lead.

Input

"utm_data": "utm_source=google&utm_medium=cpc&utm_campaign=spring2026"

Stored as

{
  "utm_source": "google",
  "utm_medium": "cpc",
  "utm_campaign": "spring2026"
}

A leading ? is tolerated and stripped. Send null or omit the field if you have no UTM data.

SMS consent

If a renter explicitly opts in to SMS communication on your form, set:

"tour_request": {
  "requestor_phone": "+15551234567",
  "sms_consent": "true"
}

• sms_consent must be the exact string "true". Booleans, 1, etc. are ignored.
• Consent is only recorded if requestor_phone is also present.
• The consent source is logged as the Host header of the request, so it's visible to compliance reviewers later.
• Without sms_consent, the customer is treated as not having opted in to SMS.

Responses

201 Created — success

{
  "id": 12345
}

id is the SeeClickRent lead ID. Persist it if you want to correlate later support requests, but you cannot read the lead back through this API.

400 Bad Request — validation or unexpected error

{
  "error": "Unable to create tour request"
}

Or, if a server-side exception was raised (bad payload shape, unparseable datetime, etc.), the exception message is returned:

{
  "error": "param is missing or the value is empty: tour_request"
}

Common causes:

• Missing tour_request wrapper object.
• Missing tour_request.requestor_email.
• Malformed JSON.

429 Too Many Requests — throttled

See Rate limits.

Other status codes

Anything in the 5xx range indicates a SeeClickRent-side problem. Retry with exponential backoff. The endpoint is not idempotent (see below), so guard against double-creating leads when retrying.

What happens after a successful call

You don't need to do anything else, but for context:

1. The customer record is created or matched (by email first, then phone).
2. A new lead is created and linked to the building identified by token.
3. A deal is created from the lead and moved to its initial pipeline stage.
4. The assigned leasing agent receives a notification email. Notification is silently skipped if:
   • the customer has been flagged as spam, or
   • the building has no agent email configured.
5. If listing_source is june_homes, the lead is also synced back to June Homes via a background job.

Idempotency

This endpoint is not idempotent — every call creates a new lead, even if you send the exact same payload twice. If your form can be submitted multiple times by the same renter (double-clicks, form retries, etc.), de-duplicate on your side before posting.

Code samples

curl -X POST https://seeclickrent.com/api/v1/website_leads \
  -H "Content-Type: application/json" \
  -d '{
    "token": "abc123def456",
    "tour_request": {
      "requestor_name": "Jane Smith",
      "requestor_email": "jane@example.com",
      "requestor_phone": "+15551234567",
      "message": "Interested in 2-bedroom units",
      "slot": "2026-05-15T14:00:00Z",
      "unit_preference": "2A",
      "utm_data": "utm_source=google&utm_campaign=spring2026",
      "sms_consent": "true"
    }
  }'

const response = await fetch("https://seeclickrent.com/api/v1/website_leads", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    token: "abc123def456",
    tour_request: {
      requestor_name: "Jane Smith",
      requestor_email: "jane@example.com",
      requestor_phone: "+15551234567",
      message: "Interested in 2-bedroom units",
      slot: "2026-05-15T14:00:00Z",
      unit_preference: "2A",
      utm_data: window.location.search.replace(/^\?/, ""),
      sms_consent: "true",
    },
  }),
});

if (response.status === 201) {
  const { id } = await response.json();
  console.log("Created lead", id);
} else {
  const { error } = await response.json();
  console.error("Lead creation failed:", error);
}

import requests

resp = requests.post(
    "https://seeclickrent.com/api/v1/website_leads",
    json={
        "token": "abc123def456",
        "tour_request": {
            "requestor_name": "Jane Smith",
            "requestor_email": "jane@example.com",
            "requestor_phone": "+15551234567",
            "message": "Interested in 2-bedroom units",
            "slot": "2026-05-15T14:00:00Z",
            "unit_preference": "2A",
            "utm_data": "utm_source=google&utm_campaign=spring2026",
            "sms_consent": "true",
        },
    },
    timeout=10,
)

if resp.status_code == 201:
    lead_id = resp.json()["id"]
    print(f"Created lead {lead_id}")
elif resp.status_code == 429:
    retry_after = int(resp.headers.get("Retry-After", "60"))
    print(f"Throttled, retry in {retry_after}s")
else:
    print(f"Failed: {resp.status_code} {resp.text}")

Troubleshooting

Support

For tokens, building setup, or rate-limit increases, reach out to your SeeClickRent point of contact or contact us.