Endpoints / intakeLead

intakeLead

Lead aus Marketing-Webform (tolerantes Schema)

Tolerantes Schema für Marketing-Formulare: flache Felder in snake_case oder camelCase, Geburtsdatum wahlweise als DD.MM.YYYY oder YYYY-MM-DD. Wird intern auf das strikte createLead-Schema gemappt.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/intakeLead

Auth basicAuth apiKey

Request Parameters

Mindestens eines von lastname, email, phone, mobile ist Pflicht.
Defaults: ispatient = 1, folderId = 1, source = I (Internet).
Beliebige Anamnese-Felder lassen sich als hx_<Key> mitgeben und landen in den medizinischen Daten des Leads.

Parameter	Pflicht	Typ	Beispiel / Default
`lastname` Eines der vier Identifikationsfelder.	optional	string	Mustermann
`email` Eines der vier Identifikationsfelder.	optional	string	max@example.com
`phone` Eines der vier Identifikationsfelder.	optional	string	+41 79 000 00 00
`mobile` Eines der vier Identifikationsfelder.	optional	string
`salutation` Anrede.	optional	string	Herr
`firstname`	optional	string	Max
`gender`	optional	string
`dob` DD.MM.YYYY oder YYYY-MM-DD.	optional	string	21.02.1980
`street` Hausnummer separat als streetex möglich.	optional	string	Musterstrasse
`zip`	optional	string	8000
`city`	optional	string	Zürich
`country` Klartext oder ISO-Code; wird serverseitig aufgelöst.	optional	string	CH
`civil_status` Zivilstand.	optional	string	Ledig
`job` Beruf.	optional	string
`comment` Anliegen; alternativ what.	optional	string	Knie-Schmerzen seit 3 Wochen
`kvg` Grundversicherer.	optional	string	Helsana
`vvg` Zusatzversicherer.	optional	string
`police_nr` Policennummer.	optional	string	12346
`newsletter` Consent; 1/0 oder true/false. Analog data_processing.	optional	integer	1
`idempotencyKey` Für Webhooks empfohlen.	optional	string

Response Parameters

Demo

Parameter und Beispiele stammen aus der internen API-Collection; die OpenAPI-Spec weicht für diesen Endpoint davon ab.

POST https://dev.vitabyte.ch/v1/sales/intakeLead

Payload

{
    "salutation": "Herr",
    "firstname": "Max",
    "lastname": "Mustermann",
    "dob": "21.02.1980",
    "email": "max@example.com",
    "phone": "+41 79 000 00 00",
    "street": "Musterstrasse",
    "streetex": "1",
    "zip": "8000",
    "city": "Zürich",
    "country": "CH",
    "civil_status": "Ledig",
    "job": "Maurer",
    "comment": "Knie-Schmerzen seit 3 Wochen",
    "kvg": "Helsana",
    "police_nr": "12346",
    "newsletter": 1,
    "hx_Hauptleiden": "Knie",
    "hx_Allergien": "Pollen",
    "idempotencyKey": "form-uuid-here"
}

Response

{
    "status": true,
    "msg": "Success",
    "result": {
        "leadId": 12346,
        "uniqid": "6a1c48d92b7f1"
    }
}