Leads API
Upgrade from API version 1 to version 2
The Leads API v2 was introduced in April 2023. The previous API version 1 is now considered deprecated and will only be supported until July 31, 2023. Please make sure to adjust your implementation before that date.
This document lines out the changes to the data structure between v1 and v2 of the API.
| v1 property | v2 property | Comment |
|---|---|---|
status | — | removed |
lead_type | — | removed |
first_name | customer.first_name | |
last_name | customer.last_name | |
tel | customer.phone | |
email | customer.email | |
request.street | customer.street | |
request.street_number | customer.street_number | |
request.zipcode | customer.zipcode | |
request.city | customer.city | |
request.planned_installation | parameters.installation_time | |
request.is_interested_in_credit | — | removed |
request.preferences | — | removed |
request.reasons | — | removed |
request.house_type | parameters.house_type | |
request.roof_material | parameters.roof_material | |
request.roof_area | parameters.roof_area | |
request.roof_orientation | parameters.roof_orientation | |
request.roof_year | — | removed |
request.pax_kwh | parameters.energy_consumption | |
request.is_interested_in_emobility | parameters.is_interested_in_emobility | |
request.is_interested_in_heat_pump | parameters.is_interested_in_heat_pump | |
request.km_per_year | — | removed |
request.battery_capacity_kwh | calculations.netto_capacity | |
request.consumption_time | — | removed |
request.is_interested_in_batteries | parameters.is_interested_in_batteries | |
request.suitability | calculations.suitability | |
request.max_solar_production_kwh | calculations.max_energy | |
request.number_of_panels | calculations.number_of_panels | |
request.production_estimate_kwh | calculations.yearly_yield | |
request.euro_savings | — | removed |
request.profit_estimate | — | removed |
request.need_estimate_percent | calculations.autarky | |
request.co2_savings | calculations.co2_savings | |
request.pv_system_cost_estimate | — | removed |
request.building_boundary_aerial_image | — | removed |
request.data_privacy | legal.data_privacy_accepted | type changed from string to boolean |
request.terms_and_conditions | legal.terms_and_conditions_accepted | type changed from string to boolean |
request.images | photos | |
request.images[].file | photos[].url | |
request.financing | parameters.financing | type changed from string to [ string one of buy|rent ] |
request.pv_area_well_suited | calculations.pv_area.well_suited | |
request.pv_area_suited | calculations.pv_area.suited | |
request.pv_area_barely_suited | calculations.pv_area.barely_suited | |
remarks | — | removed |
price_no_battery | prices.without_battery | |
price_with_battery | prices.with_battery | |
latitude | customer.coordinates.lat | |
longitude | customer.coordinates.lng | |
is_owner | parameters.customer_is_owner |
Please also refer to the example on the Data Schema description page when upgrading your implementation.