Create a lead from an external system

post

https://api.clix-crm.com/v1/public/leads

The single entry point for website forms, landing pages, Zapier and any other system
that produces enquiries. The lead is de-duplicated against the workspace's contacts
by phone and email, routed by the workspace's assignment rules, and starts its SLA
clock — exactly as a portal lead does.

The API key must carry the leads.create scope.

Send external_id whenever the sending system has its own id: it is what makes a
retry safe. When a lead with that id already exists the original is returned with
duplicate: true and status 200.

property_reference (or listing_reference) and project_reference are matched
against the workspace's own listings and projects. When one matches, the lead is
linked to it and a requirement is written from it — property type, bedrooms, a
budget band around the asking price, community — so the agent opens a brief rather
than an empty form.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Every field is optional, but a lead with neither a phone number nor an email address
cannot be de-duplicated or contacted, so send at least one.

external_id

string

length ≤ 120

The sending system's own id. Makes a retry safe.

source

string

length ≤ 60

Where it came from, e.g. website, zapier, api.

source_detail

string

length ≤ 60

Which form on the site — secondary, commercial, general. Routing rules can
match on it.

portal_code

string

length ≤ 40

campaign

string

length ≤ 120

name

string

length ≤ 180

The full name. Use this or first_name/last_name.

first_name

string

length ≤ 80

last_name

string

length ≤ 80

string

phone

string

length ≤ 40

Send it in international form (+971501234567) whenever you have it. A number
without a country code is read as local only when it is shaped like one — nine
digits, or ten with a trunk zero — so an international number pasted without its
+ is not turned into a UAE number.

message

string

length ≤ 8000

property_reference

string

length ≤ 80

The listing reference the enquiry is about. Matched against the workspace's listings.

listing_reference

string

length ≤ 80

Accepted as an alias of property_reference.

project_reference

string

length ≤ 80

The off-plan project the enquiry is about, by name or reference.

module

string

enum

Which book the lead belongs in. Leave it out for a project enquiry — the CRM
decides once the project has been matched.

Allowed:

purpose

string

enum

Defaults to buy

Allowed:

budget_min

number

≥ 0

budget_max

number

≥ 0

bedrooms

integer

0 to 20

language

string

enum

Defaults to en

Allowed:

200A lead with this external_id had already been received. The original is returned unchanged; nothing was created.

201The lead was created.

401The credential is missing or not valid.

403The credential is not a tenant API key, or the key does not carry the leads.create scope.

422The body failed validation. details names each field.

429Too many requests.