/leads/{id}/... altındadır. Lead kaynakları ise /leads/reference-sources altındadır.
Endpoint özeti
Tüm endpoint’lerhttps://app.flextell.ai/api/v1 altındadır ve Authorization: Bearer <access_token> ile X-Tenant: <tenant_id> başlıklarını ister (bkz. Klinikler ve X-Tenant). Birden fazla scope yazılan satırlarda token’ın hepsine sahip olması gerekir.
Scope kuralları için Scope’lar, izin kuralları için İzinler ve görünürlük sayfasına bakın.
/leads/{id}/... endpoint’lerinde Lead’i görebiliyor olmanız gerekir. Lead başka bir kullanıcıya atanmışsa ve ViewAllLeads:Lead izniniz yoksa 403 ve LEAD_NOT_ASSIGNED alırsınız. Yanıttaki data.assigned_user, Lead’in sahibini {id, name} olarak verir. Sahibi yoksa null döner. Lead yoksa, başka kliniğe aitse veya silinmişse 404 ve RESOURCE_NOT_FOUND alırsınız.Notlar
Not, Lead’e bağlı serbest metindir. Notları listelemek içinView:Lead ve View:Note izinleri gerekir. Yazma işlemleri Update:Lead iznini ve ilgili not iznini ister.
Not nesnesi
Listeleme
GET /leads/{id}/notes isteği şu parametreleri alır:
Not ekleme ve güncelleme
string
gerekli
Not metni. En çok 65535 karakter. Güncellemede de zorunludur.
integer
Notun yazarı. Kliniğin herhangi bir üyesi olabilir. Göndermezseniz yazar, isteği yapan kullanıcıdır. Yalnızca ekleme isteğinde kullanılır.
201 ile oluşan notu döner.
Görevler
Görev, Lead için yapılacak işi bir sorumlu ve son tarihle takip eder. Okuma içinView:Lead, tüm yazma işlemleri için Update:Lead izni yeterlidir.
Görev nesnesi
Listeleme
GET /leads/{id}/tasks isteği şu parametreleri alır:
Tarih aralıklarının genel kuralları için Filtreleme ve sıralama sayfasına bakın.
ViewAllLeads:Lead veya ViewAllCustomers:Customer izniniz varsa Lead’in tüm görevlerini görürsünüz. Bu izinler yoksa yalnızca kendinizin oluşturduğu veya size atanmış görevleri görürsünüz. Görünürlüğünüzün dışındaki bir göreve yapılan her istek 404 döner.Görev ekleme ve güncelleme
string
gerekli
Görev başlığı. En çok 255 karakter. Güncellemede isteğe bağlıdır.
string
Açıklama. En çok 65535 karakter.
integer
Sorumlu. Kliniğin aktif bir üyesi olmalıdır.
Assign:Lead izniniz yoksa değer her zaman sizin kullanıcınıza ayarlanır.string
Son tarih. Saat dilimi (offset) yazmazsanız klinik saat dilimi kabul edilir. Örnek:
2026-10-14T14:30:00+03:00.boolean
varsayılan:"true"
Görevin aktif olup olmadığı. Pasif görev için hatırlatma gönderilmez.
201 ile oluşan görevi döner. Görevi başka bir kullanıcıya atarsanız o kullanıcı Görev ataması bildirimi alır. Kendinize atarsanız veya sorumluyu temizlerseniz bildirim gitmez.
Tamamlama ve yeniden açma
POST /leads/{id}/tasks/{taskId}/complete isteği completed_at alanını şimdiki zamana ayarlar ve görevi pasif yapar (is_active: false). POST /leads/{id}/tasks/{taskId}/reopen isteği completed_at alanını temizler ve görevi yeniden aktif yapar. Yeniden açılan görev için son tarih geldiğinde hatırlatma tekrar gönderilir. Her iki istek de güncel görevi döner.
Lead hastaya dönüştürüldüğünde Lead’in görevleri kopyalanmaz. Görevler Lead’in bağlı olduğu hasta kaydı üzerinden hastanın görev listesinde de görünür. Bu liste için Hasta notları ve görevleri sayfasına bakın.
Aktiviteler
GET /leads/{id}/activities isteği Lead’e ve Lead ile ilişkili kayıtlara ait değişiklik akışını verir. Akış salt okunurdur. En yeni kayıt en başta gelir. İsteği yapmak için View:Lead ve View:ActivityLog izinleri ve hem leads:read hem activity_logs:read scope’u gerekir.
Akış şu kayıtlardaki değişiklikleri içerir: Lead’in kendisi, görevleri, notları, dosyaları ve Lead’in bağlı olduğu kişi kaydına ait iletişim kimlikleri, randevular, teklifler ve destek talepleri.
Aktivite nesnesi
Lead kaynakları
Lead kaynağı, Lead’in nereden geldiğini gösterir. Lead’lerdelead_reference_source_id alanıyla seçilir ve yanıtta reference_source olarak döner. Panelde bu kayıtlar Lead Kaynakları adıyla geçer.
Kaynaklar elle oluşturulabildiği gibi Flextell de kendisi oluşturur:
- Sohbet kanallarından gelen yeni kişiler için kanal başına bir kaynak. Adı kanalın adıdır.
- Reklam kaynaklarından gelen Lead’ler için Meta Ads, TikTok Ads ve Google Ads.
- Entegrasyonların adıyla açılan kaynaklar (örneğin Zapier).
Kaynak nesnesi
Listeleme
Listeleme içinView:LeadReferenceSource izni gerekir. View:Conversation izni olan ve token’ında conversations:read scope’u bulunan kullanıcılar da listeyi okuyabilir. Sohbet filtreleri bu listeyi kullanır.
Oluşturma, güncelleme, silme
string
gerekli
Kaynak adı. En çok 255 karakter. Klinikte aktif kaynaklar arasında benzersiz olmalıdır. Güncellemede isteğe bağlıdır.
string
Hex renk kodu:
#rgb veya #rrggbb.integer
Kaynağın bağlanacağı kanal. Kliniğinizin bir kanalı olmalıdır. Bir kanala yalnızca bir kaynak bağlanabilir. Kanallar için Kanallar sayfasına bakın.
201 ile kaynağı döner (leads_count değeri 0). Güncelleme güncel kaynağı döner. Kaynak bulunamazsa 404 döner.
Kaynağı silmek Lead’leri silmez. Lead’ler kaynağın ID’sini taşımaya devam eder, ancak yanıttaki
reference_source alanı null döner. Sohbet kanalı kaynağını silerseniz, o kanaldan gelen bir sonraki yeni kişi kaynağı otomatik olarak yeniden oluşturur veya geri getirir.