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 propertyv2 propertyComment
statusremoved
lead_typeremoved
first_namecustomer.first_name
last_namecustomer.last_name
telcustomer.phone
emailcustomer.email
request.streetcustomer.street
request.street_numbercustomer.street_number
request.zipcodecustomer.zipcode
request.citycustomer.city
request.planned_installationparameters.installation_time
request.is_interested_in_creditremoved
request.preferencesremoved
request.reasonsremoved
request.house_typeparameters.house_type
request.roof_materialparameters.roof_material
request.roof_areaparameters.roof_area
request.roof_orientationparameters.roof_orientation
request.roof_yearremoved
request.pax_kwhparameters.energy_consumption
request.is_interested_in_emobilityparameters.is_interested_in_emobility
request.is_interested_in_heat_pumpparameters.is_interested_in_heat_pump
request.km_per_yearremoved
request.battery_capacity_kwhcalculations.netto_capacity
request.consumption_timeremoved
request.is_interested_in_batteriesparameters.is_interested_in_batteries
request.suitabilitycalculations.suitability
request.max_solar_production_kwhcalculations.max_energy
request.number_of_panelscalculations.number_of_panels
request.production_estimate_kwhcalculations.yearly_yield
request.euro_savingsremoved
request.profit_estimateremoved
request.need_estimate_percentcalculations.autarky
request.co2_savingscalculations.co2_savings
request.pv_system_cost_estimateremoved
request.building_boundary_aerial_imageremoved
request.data_privacylegal.data_privacy_acceptedtype changed from string to boolean
request.terms_and_conditionslegal.terms_and_conditions_acceptedtype changed from string to boolean
request.imagesphotos
request.images[].filephotos[].url
request.financingparameters.financingtype changed from string to [ string one of buy|rent ]
request.pv_area_well_suitedcalculations.pv_area.well_suited
request.pv_area_suitedcalculations.pv_area.suited
request.pv_area_barely_suitedcalculations.pv_area.barely_suited
remarksremoved
price_no_batteryprices.without_battery
price_with_batteryprices.with_battery
latitudecustomer.coordinates.lat
longitudecustomer.coordinates.lng
is_ownerparameters.customer_is_owner

Please also refer to the example on the Data Schema description page when upgrading your implementation.

Previous
Try it out