Lead Capture API Docs

Documentation for Rechat's Lead Capture API.

On success, you may receive:

Response

• Atomic parts follow the PostGIS stdaddr model.

• line1, line2, and full can be provided directly.

• If omitted, Rechat generates them from atomic fields.

address is an object. You can send atomic parts or full lines.

Address payload

source_type is required. Everything else is optional.

• application/json

• XML (LTS format)

• application/x-www-form-urlencoded

The endpoint accepts:

Request format

lead_channel is both the endpoint identifier and the auth key.

Get it from Lead Routing in Rechat. See Lead Routing.

You need a lead_channel ID.

Before you start

Integrate lead capture into your site using Rechat’s webhook.

• 200 OK with the created lead record.

• 204 with no content.

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_channelstringRequired

Body

application/json

Example JSON payload for Rechats lead capture API. All fields are optional with this exception of source_type, which must be specified.

first_namestringOptional

Contact's first name (optional)

Example: John

last_namestringOptional

Contact's last name (optional)

Example: Doe

emailstringOptional

Contact's email (optional)

Example: [email protected]

phone_numberstringOptional

Contact's phone number (optional)

Example: [phone]

tagsstring[]Optional

An array of strings to be used as tags for categorization (optional)

Example: ["website_inquiry","new_leads"]

lead_sourcestringOptional

Source of the lead (optional)

Example: real_estate_website

notestringOptional

Additional notes or messages (optional)

Example: This is a note!

addressstringOptional

Property address of interest (optional)

Example: 123 Main Street, City, State 12345

referer_urlstringOptional

Referring URL (optional)

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

mlsidstringOptional

MLS listing ID (optional)

Example: 22425783

agent_mlsidstringOptional

Agent's MLS ID (optional)

Example: 12345678

source_typestringOptional

Required string representing the source type (Website, in this case).

Example: Website

Responses

200

OK

application/json

204

Successful operation

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: 483

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone_number": "[phone]",
  "tags": [
    "website_inquiry",
    "new_leads"
  ],
  "lead_source": "real_estate_website",
  "note": "This is a note!",
  "address": "123 Main Street, City, State 12345",
  "referer_url": "https://example.com/property/123",
  "mlsid": 22425783,
  "agent_mlsid": 12345678,
  "source_type": "Website",
  "assignees": [
    {
      "email": "text",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "mls": "text",
      "mls_id": "text"
    }
  ]
}

{
  "code": "OK",
  "data": {
    "id": "0e17f1d9-b9cb-4732-9185-fd80f990f693",
    "contact": "2ba538ee-3f2c-4ecb-b87e-a706b5c3e73f",
    "lead_channel": "55f50bdd-fc93-4737-84e4-6fa5ad97745f",
    "raw_payload": {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "source_type": "Website"
    },
    "parsed_payload": {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "source_type": "Website"
    },
    "source_type": "Website",
    "created_at": 1752247298.819
  }
}