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	Type	Description
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
email	string	Müşteri veya iletişim posta adreslerinde aranacak metin. Arama büyük/küçük harfe duyarsızdır.

200: OK Müşteri listesi

Client[]

Müşteri Ekle

POST https://cubicl.io/api/v1/crm/customers

Request Body

Name	Type	Description
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
email	string	Müşterinin e-posta adresi
fullname	string	Müşterinin adı ve soyadı

200: OK Client details

Client

Müşteri Güncelle

PUT https://cubicl.io/api/v1/crm/customers/:id

Path Parameters

Name	Type	Description
id*	string	Müşteri ID'si

Request Body

Name	Type	Description
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ı
email	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

200: OK Müşteri detayları

Client

Müşteri Sil

DELETE https://cubicl.io/api/v1/crm/customers/:id

Path Parameters

Name	Type	Description
id*	string	Müşteri ID'si

200: OK İçerik yok

Veriler

Müşteriler

type Client = {
    _id: string;
    // Kullanıcı arayüzünde gösterilen ve arama için kullanılan kısa bir ad.
    name: string;
    phone: string;
    email: string;
    fullname: string;
    // İletişim halinde olduğunuz bu müşteri ile çalışan kişiler.
    contacts: Contact[];
    // Özel alanların, adlarının ve değerlerin olduğu bir nesne.
    // customFields değeri boş olabilir.
    customFields: {
        [fieldId: string]: string | null
    } | null;
    // Bu müşterinin portal kullanıcılarından aktiviteler için bildirim alan
    // kullanıcı ID'lerinin listesi
    portalCustomerManagerIds: string[];
    createdAt: number;
}

Kişiler

type Contact = {
    name: string;
    position: string;
    phone: string;
    email: string;
}