Lead webhook
How a lead source, such as a property portal, sends leads to a firm on Terrisage CRM.
1. The address
Each firm has its own address for each source. The firm finds it in Terrisage under Integrations and sends it to you. It looks like this:
POST https://terrisage-production-app-server.onrender.com/api/inquiries/portal/{portal}/{secret}The secret in the address is the key. No API key header and no URL parameters are needed. Keep the address private: anyone who has it can send leads to the firm.
2. Create a lead
Send a POST request with a JSON body (application/json) or a plain form post (application/x-www-form-urlencoded), up to 50 KB. A JSON list of up to 50 leads is also accepted.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the lead. display_name or full_name also work. |
phone | string | Phone or email | With country code. A 10-digit number is read as Indian. |
email | string | Phone or email | |
other_fields | object | No | Everything else about the lead, as label: value pairs (project, locality, budget, message…). |
city | string | No | |
message | string | No | What the lead wrote. |
lead_id | string | No | Your own id for the lead. The same id sent again within 30 days returns the first lead instead of making a second one. |
Any other field is kept, as it arrived, in the lead's notes. Nothing is thrown away.
Example:
{
"name": "Priya Sharma",
"phone": "+919876543210",
"email": "priya@example.com",
"lead_id": "MB-7781",
"other_fields": {
"Project": "Aurora Heights",
"Budget": "1.2 Cr",
"Locality": "Kondapur"
}
}3. Response
| Status | When |
|---|---|
200 | Saved. The body is { "success": true, "lead_id": "…" }. For a list, results gives a lead_id or an error for each lead, in order. |
400 | No name, neither phone nor email, or a body that is not JSON or form data. The body says which. |
403 | The firm has switched this source off. |
404 | Unknown address, or one the firm has replaced. |
413 | Body over 50 KB. |
429 | More than 120 leads a minute on one address. Please retry shortly. |
4. Questions
Write to contact@terrisage.com.