Ana içeriğe atla
Müşteri Oluştur uç noktası, harici bir sistemden AgencyHandy çalışma alanınıza doğrudan müşteri eklemenizi sağlar. Lead’lerin aksine, müşteriler siparişlere, faturalara ve projelere atanabilen tam olarak kayıt altına alınmış kişilerdir. Yeni müşterileri bir CRM, kayıt formu veya başka herhangi bir veri kaynağından senkronize etmek için bu uç noktayı kullanın.
Bu uç noktayı kullanmadan önce API anahtarınızı ve Şirket Kimliğinizi edinmek için Başlarken rehberini tamamlayın. Lead Oluştur uç noktasının aksine, müşteri oluştururken ayrı bir Rol Kimliği arama adımı gerekmez.

Ön koşullar

  • Çalışma Alanı Yapılandırması → API Anahtarı bölümünden oluşturulan API anahtarı
  • GET {{URL}}/accounts/companies ile alınan Şirket Kimliği

Uç nokta

POST {{URL}}/members/bulk-client

Başlıklar

BaşlıkDeğer
x-api-keyAPI anahtarınız
companyIdŞirket Kimliğiniz
Content-Typeapplication/json

İstek gövdesi

İstek gövdesi bir JSON dizisidir. Tek bir istekte bir veya daha fazla müşteri oluşturabilirsiniz.
firstName
string
gerekli
Müşterinin adı.
lastName
string
gerekli
Müşterinin soyadı.
email
string
gerekli
Müşterinin e-posta adresi. Çalışma alanınızda benzersiz olmalıdır.
isConvertedClient
boolean
gerekli
Yepyeni bir müşteri için false olarak ayarlayın. Mevcut bir lead’i müşteriye dönüştürürken true olarak ayarlayın.
status
string
Müşterinin durumu. Yaygın değerler: New, Active. Belirtilmezse varsayılan olarak New kullanılır.
contactNo
string
Müşterinin telefon numarası.
source
string
Bu müşteriyi nasıl edindiğiniz. Örnek değerler: website, referral, social.
positionInBoard
number
Müşterinin sütundaki konumu. Varsayılan olarak 1 kullanılır.

Örnek istek

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-client" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyId: <YOUR_COMPANY_ID>" \
  --header "Content-Type: application/json" \
  --data '[
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

Başarı yanıtı

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
message
string
Başarı durumunda onay dizesi.
createdMembers
array
Oluşturulan müşteri nesnelerinin dizisi.
createdMembers[].\_id
string
Yeni oluşturulan müşterinin benzersiz kimliği. API aracılığıyla müşteriyi siparişlere veya faturalara atarken bu kimliği kullanın.
createdMembers[].name
string
Müşterinin tam adı (firstName + lastName).
createdMembers[].status
string
Kaydedildiği şekliyle müşterinin durumu.
createdMembers[].role
string
Üyeye atanan rol — "client" olacaktır.
Bu uç nokta için companyId başlığı büyük I harfini kullanır — companyId — tümü küçük harf kullanan bazı diğer uç noktaların aksine (companyid). Kimlik doğrulama hatalarını önlemek için yukarıda gösterilen tam büyük/küçük harf kullanımını uygulayın.
Tek bir API çağrısında toplu müşteri oluşturmak için diziye birden fazla müşteri nesnesi iletebilirsiniz. Her nesnenin benzersiz bir email adresi olmalıdır. Yinelenen e-postalar söz konusu giriş için doğrulama hatasına neden olur.