Creates a lead in the open state. Send the homeowner either as contact_id (an existing
contact) or as an inline contact object with a name (or first_name and last_name) and
optionally email and phone. If an inline contact's email or phone matches a contact already
in your company, that contact is reused and matched_existing_contact is true in the
response. When both are sent, contact_id wins. Send account_id to file a new inline contact
under a specific account. A lead can be created without a contact, but it cannot be won until it
has one.
Attach the property by sending address_ids (addresses that already belong to the contact, with
an optional primary_address_id), or by typing it into property_address, property_city,
property_state and property_zip, in which case an address is created on the contact for you.
If you leave title blank, it defaults to the address's label, then the full address, then
"New Lead". You can also send lead_stage_id to start the lead in a specific pipeline stage.
The lead is linked to the contact's account (one is created if needed) and its lead score is
calculated in the background. The token's role must be allowed to work sales.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||