Endpoints / setLeadFolder

setLeadFolder

Lead in einen anderen Pipeline-Folder verschieben

Reine Folder-Operation. Folder 5 und 15 (Disqualifizierung) sind reserviert — dafür disqualifyLead nutzen.

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Folder-IDs (Patient / Kontakt): 1 / 11 Open, 2 / 12 To be contacted, 3 / 13 In discussion, 4 / 14 Converted, 5 / 15 Disqualified, ab 100 eigene Folder.
⚠ 5 bzw. 15 wird verweigert — dafür disqualifyLead mit reasonCode verwenden. 4 bzw. 14 löst keine automatische Konversion mehr aus; dafür gibt es convertLead.

Parameter	Pflicht	Typ	Beispiel / Default
`leadId`	required	integer
`folderId`	required	integer

Response Parameters

Erzeugt automatisch einen History-Eintrag vom Typ S. Fehler: HTTP 400 Provide valid leadId and folderId., HTTP 422 FolderId 5 requires disqualifyLead.

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/setLeadFolder Erfolgsfall

Payload

{
    "leadId": 12345,
    "folderId": 3
}

Response

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

POST https://dev.vitabyte.ch/v1/sales/setLeadFolder Disqualifikation über den falschen Endpoint

Payload

{
    "leadId": 12345,
    "folderId": 5
}

Response

{
    "status": false,
    "msg": "FolderId 5 requires disqualifyLead."
}