Lead API - Update Leads

Create new instant valuation leads via the Lead API

Endpoint name: Update lead Endpoint URL: https://api.lead.pro/api/v103/leads/<id> Type: PATCH

The update lead endpoint allows you to pass a request body via a PATCH request with the ID of the lead you intend to update passed in the URI. The lead ID is sourced from the response body of the leads you create via the Create Lead endpoint.

Example Request Payload

{
    "first_name": "Joe",
    "last_name": "Bloggs",
    "address": "123 Example Street",
    "postcode": "EX1 2MP",
    "advert_address": "456 Test Lane",
    "advert_postcode": "EX3 4NP",
    "status": "Contacted",
    "office_id": 375,
    "gdpr_checkbox": true,
    "next_action_date": "2025-07-12T10:00:00Z",
    "questionnaire": [["Do you have pets?", "Yes"]],
    "meta": {
        "data2": "value2",
    }
    "utm_source": "Google",
    "utm_medium": "CPC",
    "utm_campaign": "Summer Sale",
    "utm_content": "Ad1",
    "utm_term": "Real Estate",
    "utm_gclid": "GCLID1234567890"
}

Available fields

The following fields are available to be used to update a lead.

Field Name	Type	Validation	Use
first_name *	string	length : min 1 max 50	first name of user/lead
last_name *	string	length : min 1 max 50	last name of user/lead
address	string	max 255	Contact address
postcode	string	max 255	Contact postcode
advert_address	string	max 255	Advert address
advert_postcode	string	max 255	Advert postcode
status	string		Status of the lead
office_id	number		Has to match an office ID
gdpr_checkbox	bool		If lead individual consents to GDPR
next_action_date	string	ISO8601 date string	Date of the next action on the lead
questionnaire	Collection<string, string>	max JSON byte size 2048, each value in questionnaire should be array of strings with 2 elements	Questionnaire responses. appended to existing responses
meta	Collection<string, string>	max JSON byte size 1024, object with only string values	any custom key value pairs you wish to use
utm_source	string		used for lead journeys
utm_campaign	string		used for lead journeys
utm_medium	string		used for lead journeys
utm_term	string		used for lead journeys
utm_content	string		used for lead journeys