Müşteriler
Uç noktalarında kullanılan veri türlerinin ve formatlarının tanımları sayfanın alt kısmında bulunabilir.
Uç Noktaları
Müşterileri Getir
GET
https://cubicl.io/api/v1/crm/customers
Arama kriterlerine uyan müşterileri getirir.
Query Parameters
name
string
Müşteri adında aranacak metin.
Eşleşme, yalnızca müşteri adındaki bir kelime verilen arama metniyle başlarsa gerçekleşir.
Arama büyük/küçük harfe duyarsızdır.
limit
number
Varsayılan değer : 10
skip
number
Varsayılan değer : 0
includeAllFields
string
true
: tüm müşteri alanlarını getirir.
false
: sadece müşteri ismini getirir.
Varsayılan değer : false
string
Müşteri veya iletişim posta adreslerinde aranacak metin.
Arama büyük/küçük harfe duyarsızdır.
Id'e Göre Müşteri Getir
GET
https://cubicl.io/api/v1/crm/customers/:id
Path Parameters
id*
string
Müşteri ID'si
Müşteri Ekle
POST
https://cubicl.io/api/v1/crm/customers
Request Body
name*
string
Kullanıcı arayüzünde gösterilen ve arama için kullanılan kısa bir ad
portalCustomerManagerIds
string[]
Bu müşterinin portal kullanıcılarından aktiviteler için bildirim alan kullanıcı ID'lerinin listesi
customFields
object
Özel alanların, adlarının ve değerlerin olduğu bir nesne.
contacts
Contact[]
İletişim halinde olduğunuz bu müşteri ile çalışan kişilerin listesi.
phone
string
Müşterinin telefonu
string
Müşterinin e-posta adresi
fullname
string
Müşterinin adı ve soyadı
Müşteri Güncelle
PUT
https://cubicl.io/api/v1/crm/customers/:id
Path Parameters
id*
string
Müşteri ID'si
Request Body
name*
string
Kullanıcı arayüzünde gösterilen ve arama için kullanılan kısa bir ad
fullname
string
Müşterinin adı ve soyadı
string
Müşterinin e-posta adresi
phone
string
Müşterinin telefonu
contacts
Contact[]
İletişim halinde olduğunuz bu müşteri ile çalışan kişilerin listesi.
customFields
object
Özel alanların adlarının ve değerlerin olduğu bir nesne.
portalCustomerManagerIds
string[]
Bu müşterinin portal kullanıcılarından aktiviteler için bildirim alan kullanıcı ID'lerinin listesi
Müşteri Sil
DELETE
https://cubicl.io/api/v1/crm/customers/:id
Path Parameters
id*
string
Müşteri ID'si
Veriler
Müşteriler
Kişiler
Last updated
Was this helpful?