Here is the updated documentation with the conditions mentioned boldly in the description:
# ALARMANLAGE
| Key | Description | Possible Values |
|---|---|---|
installationsort | Location where the alarm system should be installed | Haus, Wohnung, Gewerbe, Sonstiges |
anschaffung_art | Whether you want a new installation or a repair | Neuanschaffung, Reparatur |
grundstueck_flaeche | Size of the property plot | Bis 200m², 200 bis 500m², Mehr als 500m², Weiß nicht |
wohn_flaeche | Size of the living area | Bis 100m², 100 bis 200m², Mehr als 200m², Weiß nicht |
raum_absicherung_anzahl | Number of rooms that need securing | 1 bis 5, 6-10, Mehr als 10, Weiß nicht |
aussentueren_absicherung_anzahl | Number of exterior doors that need securing | 1, 2, 3 oder mehr, Weiß nicht |
fenster_absicherung_anzahl | Number of windows that need securing | 1 bis 5, 6 bis 10, Mehr als 10, Weiß nicht |
umsetzung_zeitraum | Timeframe for needing the alarm system | Schnellstmöglich, Innerhalb eines Monats, In 2 bis 3 Monaten, Weiß nicht |
termin_erwuenscht | Whether an on-site appointment is desired (required) | Ja, Nein |
# DSL
| Key | Description | Possible Values |
|---|---|---|
interesse_guenstigerer_dsl_tarif | Interest in a cheaper internet tariff | Ja, Nein |
zeit_fuer_beratungsgespraech | Available for a separate consultation appointment | Ja, Nein |
# ELEKTROROLLSTUHL
Electric wheelchairs and mobility scooters both use the ELEKTROROLLSTUHL lead type. Use modell_typ to identify the selected product. New leads contain the common fields plus the fields for the selected product; fields from the other product block are omitted.
meta.appointment_at contains the existing partner appointment as YYYY-MM-DD HH:MM:SS when one is available, otherwise it is null.
# Current fields
| Key | Applies to | Description | Possible values |
|---|---|---|---|
hilfsmittel_fuer | Both | Person who will use the aid | Für mich, Andere Person |
modell_typ | Both | Selected product | Elektrorollstuhl, Elektromobil; legacy value Egal remains accepted but is no longer collected |
koerpergroesse_cm | Both | Body height in centimetres | Integer |
koerpergroesse_ueber_2_meter | Both | Whether the user is taller than two metres | Ja, Nein |
rollstuhl_nutzer_gewicht | Both | Weight category; retained for criteria compatibility | Unter 150 KG, Mehr als 150 KG |
koerpergewicht_kg | Both | Exact body weight in kilograms | Integer |
volljaehrig | Both | Whether the user is an adult | Ja, Nein |
versicherungsart | Both | Insurance type | Gesetzlich, Privat |
krankenkasse | Both; required only when versicherungsart is Gesetzlich | Exact health-insurance name. Omit this field for Privat. | One of the supported names listed below |
aktueller_bedarf | Elektrorollstuhl | Whether there is a current need | Ja, Nein |
pflegegrad | Elektrorollstuhl | Care grade | Nein, PG 1, PG 2, PG 3, PG 4, PG 5 |
sichere_selbststaendige_nutzung | Elektrorollstuhl | Whether safe independent use is possible | Ja, Nein |
kassenfinanzierter_elektrorollstuhl_letzte_5_jahre | Elektrorollstuhl | Whether a health-insurance-funded electric wheelchair was received in the last five years | Ja, Nein |
sichere_abstellmoeglichkeit | Elektrorollstuhl | Whether safe storage is available | Ja, Nein |
zuzahlung_moeglich | Elektromobil | Whether a co-payment is possible | Ja, Nein |
# Supported krankenkasse values
The value must exactly match one of these names, including capitalization and punctuation.
# A–D
AOK Baden-WürttembergAOK BayernAOK Bremen/BremerhavenAOK HessenAOK NiedersachsenAOK NordostAOK NordwestAOK PlusAOK Rheinland-Pfalz/SaarlandAOK Rheinland/HamburgAOK Sachsen-AnhaltAudi BKKBAHN-BKKBARMERBertelsmann BKKBIG direkt gesundBKK Achenbach BuschhüttenBKK Akzo NobelBKK B. Braun Aesculap AGBKK BPWBKK Deutsche BankBKK DiakonieBKK DürkoppAdlerBKK EuregioBKK evmBKK EWEBKK exklusivBKK Faber-Castell & PartnerBKK firmusBKK FreudenbergBKK GILDEMEISTER SEIDENSTICKERBKK Groz-BeckertBKK HENSCHEL PlusBKK HerkulesBKK Karl Mayer eKVBKK LindeBKK MAHLEbkk melitta hmrBKK MerckBKK MieleBKK mkkBKK MTU FriedrichhafenBKK PFAFFBKK PfalzBKK ProVitaBKK PublicBKK PwCBKK SalzgitterBKK SBHBKK ScheufelenBKK Stadt AugsburgBKK TechnoformBKK Textilgruppe HofBKK VDNBKK VerbundPlusBKK VoralbBKK Werra-MeissnerBKK Wirtschaft & FinanzenBKK WürthBKK ZF & PartnerBKK24BMW BKKBosch BKKDAK-GesundheitDebeka BKKDIE BERGISCHE KRANKENKASSEDie Continentale BKKDKV
# E–K
energie-BKKErnst & Young BKKHeimat KrankenkasseHEKhkkIKK - Die InnovationskasseIKK Brandenburg und BerlinIKK classicIKK gesund plusIKK SüdwestKKHKnappschaftKoenig & Bauer BKKKrones BKK
# L–Z
LKKMercedes-Benz BKKmhplus BKKMobil KrankenkasseNovitas BKKPostbeamtenkrankenkasse (PBeaKK)Pronova BKKR+V BKKSalus BKKSBKSECURVITASKD BKKSüdzucker BKKTKTUI BKKVIACTIV Krankenkassevivida BKKWMF BKK
# Handling current and historical leads
Newly qualified leads use the current fields documented above. Historical leads can still contain legacy fields when they are retrieved through the API. Partner integrations should support both formats during the transition and ignore unknown lead_data keys.
| Legacy field that may appear | Current lead data |
|---|---|
probefahrt_erwuenscht | No replacement. Newly qualified leads omit this field because a test drive is already a prerequisite. |
hilfe_genehmigung_rezept | No replacement. Newly qualified leads omit this field. |
ist_privatversichert | Replaced by versicherungsart with the value Gesetzlich or Privat. |
ist_aok_bayern | Replaced by krankenkasse, which contains the exact insurer name. |
ist_aok_baden_wuerttemberg | Replaced by krankenkasse, which contains the exact insurer name. |
ist_aok_plus | Replaced by krankenkasse, which contains the exact insurer name. |
ist_aok_niedersachsen | Replaced by krankenkasse, which contains the exact insurer name. |
gesetzliche_krankenkasse_in_liste | Replaced by krankenkasse, which contains the exact insurer name instead of a grouped Yes/No answer. |
hat_bereits_elektrisches_hilfsmittel_beantragt | Replaced by the more specific kassenfinanzierter_elektrorollstuhl_letzte_5_jahre. The meanings differ, so the old answer should not be treated as the new answer. |
rezept_bereits_beim_sanitaetshaus_abgegeben | No replacement. Newly qualified leads omit this field. |
kann_vorkasse_3890_euro_tragen | Elektromobil leads now use zuzahlung_moeglich. The meanings differ, so the old answer should not be treated as the new answer. |
When processing a lead:
- Prefer a current field when both the current and legacy field are present.
- Treat a missing field as “not supplied,” not as
Nein. - Continue accepting
modell_typ = Egalon historical leads. Newly qualified leads useElektrorollstuhlorElektromobil. rollstuhl_nutzer_gewichtremains unchanged and continues to useUnter 150 KGorMehr als 150 KG.
# ENERGIEBERATUNG
| Key | Description | Possible Values |
|---|---|---|
installationsort | Installation location | Ein-Zweifamilienhaus, Mehrfamilienhaus, Gewerbe |
mehrfamilienhaus_1_bis_4_wohneinheiten | Whether the building has 1-4 residential units | Ja, Nein |
gebaeude_alter | Age of the building | Any number (free text) |
heizungsart_aktuell | Current heating type | Öl, Gas, Holz, Pellets, Strom, Sonstiges, Weiß ich nicht |
termin_erwuenscht | Whether an on-site appointment within 2-4 weeks is possible | Ja, Nein |
# HAUSNOTRUF
| Key | Description | Possible Values |
|---|---|---|
hausnotruf_person | Who is the home emergency system for? | Für einen Angehörigen, Für mich selbst |
hausnotruf_einsatzort | Where is the home emergency system needed? | Im Haus, Draußen, Beides |
hausnotruf_pflegegrad_vorhanden | Is there a care level? | Ja, Nein, Ich brauche Unterstützung |
hausnotruf_pflegegrad | Which care level? (only if hausnotruf_pflegegrad_vorhanden = Ja) | Pflegegrad 1, Pflegegrad 2, Pflegegrad 3, Pflegegrad 4, Pflegegrad 5 |
# IMMOBILIE
| Key | Description | Possible Values / Type |
|---|---|---|
type | Type of property | Haus, Wohnung, Grundstück, Gewerbe |
haus_art | Type of house | Einfamilienhaus, Reihenhaus, Doppelhaushälfte, Mehrfamilienhaus, Wohn-/Geschäftshaus |
wohnung_art | Type of apartment | Erdgeschosswohnung, Etagenwohnung, Dachgeschoss, Andere |
grundstueck_art | Type of land | Bauland, Ackerland, Wald/Grünland, Sonstiges |
gewerbe_art | Type of commercial property | Büro/Praxis, Halle/Produktion, Gastronomie/Hotel, Einzelhandel, Sonstiges, Büro- oder Lagergebäude, Wohn- und Geschäftsgebäude, Industrie- oder Gewerbegebäude |
haus_flaeche_wohn | Living area of the house (m²) | Any number (dynamic) |
wohnung_flaeche | Apartment area (m²) | Any number (dynamic) |
grundstueck_flaeche | Land area | bis 300 m², 301 - 1000 m², über 1000 m², Weiß nicht |
gewerbe_flaeche_nutz | Usable area of commercial property (m²) | Any number (dynamic) |
grundstueck_erschlossen | Land development status | Erschlossen, Teilerschlossen, Unerschlossen |
grundstueck_zuschnitt | Land layout | Rechteckiger Zuschnitt, Eckgrundstück, Sonstiges |
haus_flaeche_grund | Land area of the house (m²) | Any number (dynamic) |
gewerbe_flaeche_grund | Ground area of commercial property | Any numeric value |
haus_anzahl_zimmer | Number of rooms in house | Any numeric value |
wohnung_zimmer | Number of rooms in apartment | Any numeric value |
haus_anzahl_baeder | Number of bathrooms in house | 1, 2, 3 |
wohnung_anzahl_baeder | Number of bathrooms in apartment | 1, 2, 3 |
ist_eigentuemer | Ownership status | Ja, Nein, Teileigentümer, Angehöriger |
zustand | Condition of property | Gehoben, Normal, Einfach, Renovierungsbedürftig |
nutzung | Usage | Selbst bewohnt, Vermietet, Teilweise vermietet, Frei |
wohnung_vermietet | Rental status of the apartment | Selbst bewohnt, Vermietet, Leerstehend |
gewerbe_vermietet | Rental status of commercial property | Selbst genutzt, Vermietet, Leerstehend |
haus_baujahr | Year of construction of the house | Any numeric value or year |
wohnung_baujahr | Year of construction of the apartment | Any numeric value or year |
gewerbe_baujahr | Year of construction of the commercial property | Any numeric value or year |
verkaufszeitpunkt | Planned selling time | Schnellstmöglich, In den nächsten Monaten, In den nächsten Jahren, Momentan nicht, Innerhalb 6 Monaten, Innerhalb 2 Jahre, Nach 2 Jahren |
verkaufsgrund | Reason for selling | Alter/Rente, Erbe, Scheidung, Marktsituation, Umzug, Anderer |
grundstueck_bebauung | Buildability of the land | Kurzfristig bebaubar, Eingeschränkt bebaubar, Nicht bebaubar, Weiß nicht |
haus_etagenanzahl | Number of floors in the house | 1, 1.5, 2, 2+ |
interesse | Interest in the property | Verkauf, Kauf |
teilverkauf | Interest in partial sale | Ja, Nein, Telefonische Beratung |
termin_erwuenscht | Whether an on-site appointment is desired | Ja, Nein |
verkauf_erwuenscht | Whether the property is intended for sale | Ja, Nein |
verkaufszeitpunkt_abfrage | When the property should be sold | Schnellstmöglich, Innerhalb 6 Monate, Innerhalb 1 Jahr, Innerhalb 2 Jahre, Länger als 2 Jahre |
bewertung_erwuenscht | Whether only a property valuation is desired | Ja, Nein |
makler_vorhanden | Whether the user is already working with a broker | Ja, Nein |
# KAFFEEVOLLAUTOMAT
| Key | Description | Possible Values |
|---|---|---|
art | Type of coffee machine | Tischgerät, Standgerät, Weiß nicht |
tassen_pro_tag | Cups per day | 10 bis 20, 20 bis 50, 50 bis 100, mehr als 100 |
anzahl_geraete | Number of devices | 1, 2, 3, Weiß nicht |
getraenkesortiment | Range of beverages offered | Minimal, Standard, Umfangreich, Weiß nicht |
verwendung | Intended use | Kleingewerbe, Gastronomie / Hotel, Büro, Privatgebrauch |
neugruendung | New establishment timing | Nein, 6 - 12 Monate, 1 - 6 Monate |
firma | Name of the Company | Any string |
# MATRATZENREINIGUNG
| Key | Description | Possible Values |
|---|---|---|
alter | Age | any |
beruf | Occupation | Sitzende Tätigkeit, Stehende Tätigkeit, Rentner*in, Arbeitssuchend |
termin_erwuenscht | Appointment desired | Ja, Nein |
# PFLEGEBOX
| Key | Description | Possible Values |
|---|---|---|
pflegegrad_vorhanden | Care level status | Ja, Nein |
pflegebox_abo_vorhanden | Already using a Pflegebox Service | Ja, Nein |
beratungsgespraech_telefon | Can the Lead attend a phone consultation | Ja, Nein |
# PKV
| Key | Description | Possible Values |
|---|---|---|
versicherungsstatus | Insurance status | Gesetzlich versichert, Privat Versichert |
gender | Gender of the insured person | Männlich, Weiblich |
versicherungsnehmer_art | Type of policyholder | Erwachsener, Kind, Familie |
versicherungsnehmer_anzahl | Number of people to be insured | 1 Person, 2 Personen, 3 Personen, 4 oder mehr Personen |
versicherungsnehmer_berufsstatus | Occupational status | Angestellter, Selbständiger, Freiberufler, Student, Sonstige |
versicherung_start | Desired insurance start time | Möglichst schnell, In 1-3 Monaten, In über 3 Monaten |
jahresbruttoeinkommen_groesser_69300 | Annual gross income above 69,300€ | Ja, Nein |
date_of_birth | Date of birth | Any text value |
# SOLARANLAGE
| Key | Description | Possible Values |
|---|---|---|
installationsort | Installation location | Ein-Zweifamilienhaus, Mehrfamilienhaus, Firmengebäude, Freilandfläche, Sonstiges |
flaeche | Area size | Bis 30qm, 30 bis 100 qm, 101 bis 200 qm, Über 200 qm |
nutzen | Intended use | Netzeinspeisung, Eigenverbrauch, Beides |
dachform | Roof shape | Satteldach, Pultdach, Flachdach, Sonstiges |
verschattung | Shading | Nein, Ja, Weiß nicht |
stromspeicher | Electricity storage | Ja, Nein, Weiß nicht |
finanzierungsmodell | Financing model | Beides interessant, Mieten, Kaufen |
umsetzung_zeitraum | Implementation timeframe | Umgehend, In 1 - 3 Monaten, In 3 - 6 Monaten, Länger als 6 Monate |
interesse_stromtarif | Interest in electricity tariff | Ja, Nein |
# TEILVERKAUF
| Key | Description | Possible Values |
|---|---|---|
type | Type of property | Haus, Wohnung |
haus_art | Type of house | Einfamilienhaus, Reihenhaus, Doppelhaushälfte, Mehrfamilienhaus, Wohn-/Geschäftshaus |
wohnung_art | Type of apartment | Erdgeschosswohnung, Etagenwohnung, Dachgeschoss, Andere |
teilverkauf_einschaetzung_wert | Estimated value for partial sale | Any numerical value |
teilverkauf_gewuenschte_auszahlung | Desired payout amount for partial sale | Any numerical value |
haus_flaeche_wohn | Living area of the house | Any numerical value (in square meters) |
wohnung_flaeche | Area of the apartment | Any numerical value (in square meters) |
haus_flaeche_grund | Ground area of the house | Any numerical value (in square meters) |
haus_anzahl_zimmer | Number of rooms in the house | Any numerical value |
wohnung_zimmer | Number of rooms in the apartment | Any numerical value |
zustand | Condition of the property | Neubau, Gepflegt, Renovierungsbedürftig, Sanierungsbedürftig |
haus_baujahr | Year of construction of the house | Any year |
wohnung_baujahr | Year of construction of the apartment | Any year |
teilverkauf_motivation | Motivation for partial sale | Liquidität, Wünsche erfüllen, Renovierung, Schulden, Sonstiges |
verkaufszeitpunkt | Planned time for the partial sale | Schnellstmöglich, In 1-3 Monaten, In 3-6 Monaten, In über 6 Monaten |
# TERRASSENDACH
| Key | Description | Possible Values |
|---|---|---|
groesse | Size of the terrace roof | Bis 15 m², Zwischen 15 und 30m², Mehr als 30 m², Weiß nicht |
materialart | Type of material | Aluminium, Holz, Materialmix, Weiß nicht |
wie-konstruiert | Construction style | Als Anbau, Freistehend, Weiß nicht |
dachform | Roof shape | Pultdach, Flachdach, Satteldach, Walmdach |
dachdeckung | Type of roof covering | Glas, Ziegeln, Dachbegrünung, Stegplatten |
element | Presence of specific elements/features | Ja, Nein, Weiß nicht |
budget | Budget for the project | Bis 4.000 Euro, 4.000 - 12.000 Euro, 12.000 - 20.000 Euro, Weiß nicht |
bauvorhaben | Timeline for the construction project | Kurzfristig (1 - 3 Monate), Mittelfristig (3 - 12 Monate), Langfristig (Länger als 12 Monate), Weiß nicht |
# TREPPENLIFT
| Key | Description | Possible Values |
|---|---|---|
liftart | Type of stair lift | Sitzlift, Plattformlift, Hublift, Weiß nicht |
lift_position | Location of the stair lift | Innen, Außen, Weiß nicht |
hindernis | Type of obstacle | Gerade Treppe, Treppe mit Kurve, Sonstiges Hindernis, Weiß nicht |
lift_etagen | Number of floors the lift will service | Bis zu 2, Mehr als 2, Sonstiges Hindernis, Weiß nicht |
pflegegrad | Care level status | Any String value (formerly Pflegegrad erteilt, Pflegegrad beantragt, Keinen Pflegegrad, Weiß nicht) |
lieferzeit | Delivery time frame | So schnell wie möglich, In 3-4 Monaten, In über 4 Monaten, Weiß nicht |
staatliche_foerderung | Eligibility for state funding | Ja, Nein, Weiß nicht |
termin_erwuenscht | Appointment desired | Ja, Nein |
sitzlift_vorstellen | Demonstrate chair lift (Sitzlift) | Ja, Nein |
miete_eigentum | Rental or ownership status | Miete, Eigentum |
miete_einverstaendnis_vermieter | Landlord's consent for rental | Ja, Nein |
haus_typ | Type of house | Einfamilienhaus, Zweifamilienhaus, Mehrfamilienhaus |
treppe_breiter_60 | Stair width greater than 60 cm | Ja, Nein |
treppe_breiter_120 | Stair width greater than 120 cm | Ja, Nein |
tragfaehigkeit | Load capacity of the stair lift | Bis 90 KG, Bis 125 KG, Über 125 KG |
# WAERMEPUMPE
| Key | Description | Possible Values |
|---|---|---|
installationsort | Installation location | Ein-Zweifamilienhaus, Mehrfamilienhaus, Firmengebäude, Sonstiges |
heizungsart_aktuell | Current heating system | Öl / Gas, Holz / Pellets, Strom, Sonstiges / Weiß ich nicht |
beheizte_flaeche | Heated area | Bis 50qm, 50 bis 100 qm, 100 bis 200 qm, Mehr als 200 qm |
waermeabgabesystem | Heat distribution system | Fußboden, Heizkörper, Beides, Hierzu wünsche ich eine Beratung |
interesse_photovoltaikanlage | Interest in photovoltaic system | Ja bitte, Nein danke, Bitte Beratung |
beginn_heizungseinbau | Planned start of heating installation | Umgehend, In 1 - 3 Monaten, In 3 - 6 Monaten, Länger als 6 Monate |
ist_eigentuemer | Are you the owner of the house? | Ja, Nein |
termin_erwuenscht | Do you want an on-site appointment? | Ja, Nein |
ist_neubau | Is it a new building? | Ja, Nein |
# ZAHNZUSATZ
| Key | Description | Possible Values |
|---|---|---|
berufsstatus | Occupational Status | Angestellt, Beamter, Freiberufler / Selbständig, Andere |
versicherungsstatus | Insurance Status | Gesetzlich, Privat, Nicht versichert |
zahnersatz_vorhanden | If dentures have already been performed | Ja, Nein |
date_of_birth | Date of Birth | Any Text |
termin_erwuenscht | Interest in on-site appointment | Ja, Nein |
termin_telefonisch | Interest in a telephone consultation | Ja, Nein |