Skip to main content
Tüm isteklerde X-Tenant header’ı zorunludur. İşlemler yalnızca belirtilen tenant’a ait lead kayıtları ile sınırlandırılmıştır.

Endpoint özeti

Lead statüleri

MetotEndpointAçıklama
GET/api/v1/leads/statusesTenant’a ait tüm lead statülerini listeler
POST/api/v1/leads/statusesYeni lead statüsü oluşturur
PUT/api/v1/leads/statuses/{id}Lead statüsünü günceller
DELETE/api/v1/leads/statuses/{id}Lead statüsünü siler

Lead CRUD

MetotEndpointAçıklama
GET/api/v1/leadsLead’leri filtreli olarak listeler
GET/api/v1/leads/{id}Tek bir lead’i detaylı getirir
POST/api/v1/leadsYeni lead oluşturur
PUT/api/v1/leads/{id}Lead’i kısmi günceller
DELETE/api/v1/leads/{id}Lead’i siler
POST/api/v1/leads/{id}/convertLead’i müşteriye dönüştürür
Tüm parametreler, alanlar ve örnek istek/yanıtlar için API Referansı sekmesine bakın.

Lead kavramı

Lead, kliniğe ilgi gösteren ancak henüz hasta kaydı oluşturulmamış potansiyel müşteriyi temsil eder. Bir lead; iletişim bilgileri, kaynak, atanmış kullanıcı, statü ve dönüşüm durumu ile yönetilir. Lead statüleri tenant bazında özelleştirilebilir. Her statü; renk, sıralama, varsayılan (is_default) ve terminal (is_terminal) işaretleri ile yapılandırılabilir.

İş kuralları

phone_number normalizasyonu: Girilen telefon numarası sistem tarafından otomatik olarak normalize edilir. Tenant içinde benzersiz olmalıdır.
Statü benzersizliği: POST /leads/statuses ile oluşturulan statü adı (name) tenant içinde benzersiz olmalıdır.
is_terminal: Terminal olarak işaretlenen statüler lead akışının son adımını temsil eder (örn. “Kaybedildi”, “Dönüştürüldü”).

Lead → Müşteri dönüşümü (POST /leads/{id}/convert)

existing_customer_id gönderilirse lead mevcut bir müşteriyle ilişkilendirilir; gönderilmezse sistem otomatik olarak yeni bir müşteri kaydı oluşturur.
Yanıt { result, customer, lead } yapısında döner.

Yetkilendirme

Uygulama izinleri (permissions)

İşlemPermission
ListelemeViewAny:Lead
Detay / Tek göstermeView:Lead
OluşturmaCreate:Lead
GüncellemeUpdate:Lead
SilmeDelete:Lead

Token scope’ları (Passport)

İşlemScope
Okuma (index, show, statuses)leads:read
Yazma (store, update, destroy, convert, statü yönetimi)leads:write