This resource only offers creation of leads using a POST request. They are passed on to the CRM system and aren't stored locally. A number of fields are strict enum fields, which only allow the string values documented below. Only the email address is required.


POST /api/leads

Supported Formats

application/json, application/x-www-form-urlencoded

Errors

Code Description
422 Unprocessable entity

Examples

curl -vvvv -X POST -H "Content-Type: application/json"  https://kisk-production.herokuapp.com/api/leads --data @- <<EOS
{
  "phone": "(525)-927-3125",
  "email": "debra.dunn68@example.com",
  "beschaffungszeitraum": "In den nächsten 3 Monaten",
  "finanzierung": "Langzeitmiete",
  "kraftstoff": "Hybrid",
  "anfrage_nr": "22043",
  "analytics_client_id": "GA10000000000676",
  "fahrzeugtyp": "Nutzfahrzeug",
  "fahrzeugklasse": "Kleiner Kastenwagen",
  "note": "Freitext"
}
EOS

Params

Param name Description
email
required

Email

Validations:

  • Must match regular expression /\b[A-Z0-9._%+-=]+@[A-Z0-9.-]+.[A-Z]{2,}\b/.

anfrage_nr
optional

Anfragenummer

Validations:

  • Must be a String

analytics_client_id
optional

Analytics Client-ID

Validations:

  • Must be a String

phone
optional

Telefonnummer

Validations:

  • Must be a String

kraftstoff
optional

Kraftstoffart, mehrere zulässige Werte

Validations:

  • Must be one of: Diesel, Benzin, Elektro / Erdgas, Hybrid, Egal, K.A..

fahrzeugtyp
optional

Fahrzeugtyp, mehrere zulässige Werte

Validations:

  • Must be one of: PKW, Nutzfahrzeuge, K.A..

fahrzeugklasse
optional

Fahrzeugklasse, mehrere zulässige Werte

Validations:

  • Must be one of: Kleinwagen, Kompaktklasse, Mittelklasse / Oberklasse, Kleiner Kastenwagen, Mittlerer Kastenwagen, Großer Kastenwagen, K.A..

beschaffungszeitraum
optional

Beschaffungszeitraum, mehrere zulässige Werte. Im Zusammenhang mit Kauf/Finanzierung wird dieser Parameter auch 'Geplanter Kaufzeitraum' genannt, für LZM auch 'Lieferzeit'.

Validations:

  • Must be one of: Sofort, In 1 - 3 Monaten, In den nächsten 3 Monaten, In 3 - 6 Monaten, In 6 – 12 Monaten, K.A..

laufzeit
optional

Anzahl; bei Langzeitmiete in Monaten, bei Finanzierung in Jahren. Im Zusammenhang mit LZM wird die Laufzeit auch als 'Mietdauer' bezeichnet.

Validations:

  • Must be a Integer

mietdauer
optional

Länger der Mietdauer; nur zutreffend bei LZM.

Validations:

  • Must be one of: 1 - 6 Monate, 6 - 12 Monate, 12 - 24 Monate, Weiß nicht.

laufleistung
optional

Laufleistung bei LZM oder Leasing. Bei LZM ist der Wert als Monatslaufleistung zu verstehen; bei Leasing ist es ein Jahreswert.

Validations:

  • Must be a String

finanzierung
optional

Finanzierung, mehrere zulässige Werte

Validations:

  • Must be one of: Leasing, Finanzierung, Bar, Langzeitmiete, Weiß nicht.

note
optional

Freitextfeld für weitere Hinweise, z.B. zusammengesetzte weitere Formularfelder

Validations:

  • Must be a String