Lead Capture API Docs

Documentation for Rechat's Lead Capture API.

In addition to the documentation for Rechat's Lead Capture API, below, you can download the OpenAPI specification here.

Capture leads using a known lead channel ID (webhook).

post

Integrate Rechat's lead capture functionality into your website using your lead_channel id (which you can get through Rechat's Lead Routing interface).

Path parameters

lead_channelstring · uuidRequired

Your lead channel ID. This serves as both the endpoint identifier and authentication key.

Example: 55f50bdd-fc93-4737-84e4-6fa5ad97745f

Body

application/json

JSON payload for Rechat's lead capture API. All fields are optional.

first_namestringOptional

Contact's first name

Example: John

last_namestringOptional

Contact's last name

Example: Doe

emailstring · emailOptional

Contact's email address

Example: [email protected]

phone_numberstringOptional

Contact's phone number

Example: [phone]

tagstring[]Optional

Array of tags for categorization

Example: ["Lead","Website Inquiry"]

lead_sourcestringOptional

Source of the lead

Example: Lead Capture Demo

notestringOptional

Additional notes or messages

Example: Interested in downtown properties

referer_urlstring · uriOptional

Referring URL

Example: https://example.com/property/123

Responses

200

OK

application/json

204

Successful operation (no content returned)

post

/leads/channels/{lead_channel}/webhook

HTTPcURLJavaScriptPython

POST /leads/channels/{lead_channel}/webhook HTTP/1.1
Host: api.rechat.com
Content-Type: application/json
Accept: */*
Content-Length: 858

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone_number": "[phone]",
  "tag": [
    "Lead",
    "Website Inquiry"
  ],
  "lead_source": "Lead Capture Demo",
  "note": "Interested in downtown properties",
  "listing": {
    "price": 750000,
    "mls_number": "5039447",
    "cover_image_url": "https://example.com/images/property.jpg",
    "property": {
      "address": {
        "street_number": "123",
        "street_dir_prefix": "N",
        "street_name": "Main",
        "street_suffix": "St",
        "street_dir_suffix": "NE",
        "unit_number": "#5",
        "city": "San Francisco",
        "state_code": "CA",
        "postal_code": "94102",
        "country": "United States",
        "direction": "North",
        "street_address": "123 N Main St NE",
        "full_address": "123 N Main St NE"
      }
    }
  },
  "referer_url": "https://example.com/property/123",
  "assignees": [
    {
      "email": "[email protected]",
      "phone_number": "[phone]",
      "first_name": "Jane",
      "last_name": "Smith",
      "mls": "NTREIS",
      "mls_id": "12345678"
    }
  ]
}

{
  "code": "OK",
  "data": {
    "id": "0e17f1d9-b9cb-4732-9185-fd80f990f693",
    "contact": "2ba538ee-3f2c-4ecb-b87e-a706b5c3e73f",
    "lead_channel": "55f50bdd-fc93-4737-84e4-6fa5ad97745f",
    "raw_payload": {},
    "parsed_payload": {},
    "created_at": 1752247298.819
  }
}