Endpoints / convertLead

convertLead

Lead zu Patient oder Kontakt konvertieren (idempotent)

target='patient' erzeugt tblPatienten-Eintrag, 'contact' tblKontakt. Idempotent: zweiter Call mit demselben Lead returnt die existierenden IDs ohne neuen Insert.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/convertLead
Auth basicAuth apiKey

Request Parameters

Optionen (alle optional): copyFiles (Default true) kopiert Lead-Dateien in den Patienten- bzw. Kontaktordner, importHxAsKg (Default true) legt die Anamnese-Daten als KG-Einträge an (nur bei target patient), createInitialAppointment (Default false) legt einen Stub-Termin an, createRecallFromNextStep (Default false) leitet einen Recall aus dem nächsten Schritt ab.

Parameter Pflicht Typ Beispiel / Default
leadId required integer
target required string
enum: patient | contact
options

Optionale Overrides (z.B. mandantId, gruppe)

 optional object

Response Parameters

Idempotent: ein zweiter Aufruf liefert die vorhandenen IDs ohne neue Inserts. Fehler: HTTP 400 bei fehlender leadId oder fehlendem target, HTTP 422 Lead already converted.

Field Typ Beschreibung
patid integer Angelegter oder vorhandener Patient
kontaktId integer Angelegter oder vorhandener Kontakt (bei target contact)
importedKgIds array IDs der aus der Anamnese erzeugten KG-Einträge
copiedFiles integer Anzahl kopierter Dateien

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/sales/convertLead
Payload
{
    "leadId": 12345,
    "target": "patient",
    "options": {
        "copyFiles": true,
        "importHxAsKg": true,
        "createInitialAppointment": false,
        "createRecallFromNextStep": false
    }
}
Response
{
    "status": true,
    "msg": "Success",
    "result": {
        "patid": 789,
        "kontaktId": null,
        "importedKgIds": [
            88,
            89,
            90
        ],
        "copiedFiles": 5
    }
}