Endpoints / setLeadFlags

setLeadFlags

Flags eines Leads setzen (Replace, kein Merge)

Replace-Semantik: das übergebene flags-Array ersetzt komplett die bestehenden Flags. Verfügbare Flags via getReferenceData(kinds=['flags']).

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Replace-Semantik: das übergebene Array ersetzt die bestehenden Flags komplett; ein leeres Array entfernt alle. Gültige Codes liefert getReferenceData(kinds=["flags"], ispatient=<0|1>) — Patient- und Kontakt-Pipeline haben unterschiedliche Flag-Gruppen.

Parameter	Pflicht	Typ	Beispiel / Default
`leadId`	required	integer
`flags`	required	array

Response Parameters

Fehler: HTTP 400 Provide a valid leadId.

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

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

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

Payload

{
    "leadId": 12345,
    "flags": [
        "VIP",
        "Rueckruf"
    ]
}

Response

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