Endpoints / modifyLead

modifyLead

Lead-Datenfelder aktualisieren (PATCH-Semantik)

Nur die gesendeten Felder werden geändert. leadId ist Pflicht. Für Folder-Wechsel → setLeadFolder.

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

PATCH-Semantik: nur die übergebenen Felder werden geändert. Pipeline, Status, Assignee und Flags haben eigene Endpoints (setLeadFolder, disqualifyLead, setLeadAssignee, setLeadFlags).

Parameter	Pflicht	Typ	Beispiel / Default
`leadId`	required	integer	12345
`contact` title, salutation, firstname, lastname, alias, gender, dob, civilStatus, nationality.	optional	object
`address` street, zip, city, country, countryCode.	optional	object
`communication` mail, mail2, phone, phone2, mobile, mobile2.	optional	object
`medical` bloodType, height, weight, job, hxData.	optional	object
`insurance` kvg, kvgPoliceNr, vvg, payerType.	optional	object
`source` Quellcode des Leads.	optional	string
`what` Anliegen.	optional	string
`nextStep` Nächster Schritt.	optional	string
`revenue` Erwarteter Umsatz.	optional	number
`costs` Erwartete Kosten.	optional	number
`settings` Lead-spezifische Einstellungen, z. B. Consent-Flags.	optional	object

Response Parameters

Fehler: HTTP 400 Provide a valid leadId., HTTP 404 Lead not found.

Field	Typ	Beschreibung
`status`	boolean	true bei Erfolg, false bei Fehler
`msg`	string	Kurzbeschreibung des Resultats / der Fehlerursache
`result`		Endpoint-spezifisches Resultat. Typ je nach Endpoint (Object, Array, Skalar oder null).
`pagination`		Nur bei Listen-Endpoints gesetzt

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/modifyLead

Payload

{
    "leadId": 12345,
    "contact": {
        "firstname": "Maximilian"
    },
    "address": {
        "city": "Bern"
    },
    "communication": {
        "mail2": "alt@example.com"
    }
}

Response

{
    "status": true,
    "msg": "Success",
    "result": null
}