Ana içeriğe atla
Lead Oluştur uç noktası, harici herhangi bir sistemden — web formu, CRM, pazarlama otomasyon platformu veya özel bir komut dosyası — AgencyHandy çalışma alanınıza programatik olarak yeni lead’ler eklemenizi sağlar. Bu uç nokta aracılığıyla oluşturulan lead’ler, tıpkı manuel olarak eklenmiş gibi anında lead hattınızda görünür.
Bu uç noktayı kullanmadan önce API anahtarınızı ve Şirket Kimliğinizi edinmek için Başlarken rehberini tamamlayın. Ayrıca lead oluştururken gerekli olan Müşteri Rol Kimliğini de almanız gerekmektedir.

​
Ö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
  • ✅ Müşteri Rol Kimliği alındı (aşağıdaki 1. Adım’a bakın)

​
1. Adım: Müşteri Rol Kimliğini alın

Lead oluşturmadan önce şirketinizdeki client rolünün Rol Kimliğine ihtiyacınız vardır.

​
Uç nokta

GET {{URL}}/roles?type=company

​
Başlıklar

BaşlıkDeğer
x-api-keyAPI anahtarınız
companyidŞirket Kimliğiniz

​
Örnek istek

cURL
curl --request GET "https://api.agencyhandy.com/roles?type=company" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyid: <YOUR_COMPANY_ID>"

​
Örnek yanıt

{
  "roles": [
    {
      "_id": "6525994184e9ddd798534535",
      "role": {
        "_id": "6525994184e9ddd79853451e",
        "responsibility": "",
        "name": "client"
      },
      "company": "6525994184e9ddd79853450e",
      "createdAt": "2023-10-10T18:34:41.567Z",
      "updatedAt": "2024-10-01T07:28:48.340Z",
      "__v": 0,
      "type": "company"
    }
  ]
}
roles[0].role.name === "client" olan girişi bulun ve dış _id’yi çıkarın — bu roles[0]._id’dir, roles[0].role._id değil. 
const clientRoleId = roles.find(r => r.role.name === "client")._id;
// e.g. "6525994184e9ddd798534535"
roles[0]._id’yi (şirket-rol eşleme kimliği) kullanın, roles[0].role._id’yi (rol tanım kimliği) değil. Yanlış kimlik kullanılması lead oluşturma isteğinin başarısız olmasına neden olur.

​
2. Adım: Yeni lead oluşturun

​
Uç nokta

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

​
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 çağrıda bir veya daha fazla lead oluşturabilirsiniz.
​
firstName
string
gerekli
Lead’in adı.
​
lastName
string
gerekli
Lead’in soyadı.
​
email
string
gerekli
Lead’in e-posta adresi. Çalışma alanınızda benzersiz olmalıdır.
​
role
string
gerekli
  1. Adım’da alınan Müşteri Rol Kimliği (yani roles[0]._id).
​
isConvertedClient
boolean
gerekli
Lead oluştururken false olarak ayarlanmalıdır. Yalnızca bir lead’i tam müşteriye dönüştürürken true olarak ayarlayın.
​
status
string
Lead’in hattaki durumu. Yaygın değerler: New, Contacted, Qualified. Belirtilmezse varsayılan olarak New kullanılır.
​
contactNo
string
Lead’in telefon numarası.
​
source
string
Bu lead’i nasıl edindiğiniz. Örnek değerler: website, referral, social.
​
positionInBoard
number
Lead’in hat sütunundaki konumu (sırası). Varsayılan olarak 1 kullanılır.

​
Örnek istek

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-lead" \
  --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",
      "role": "6525994184e9ddd798534535",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

​
Başarı yanıtı

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Onay dizesi: "Lead created successfully".
​
createdMembers
array
Oluşturulan lead nesnelerinin dizisi.
​
createdMembers[].\_id
string
Yeni oluşturulan lead’in benzersiz kimliği. Sonraki API çağrılarında lead’e başvurmanız gerekiyorsa bunu saklayın.
​
createdMembers[].name
string
Lead’in tam adı (firstName + lastName).
​
createdMembers[].status
string
Kaydedildiği şekliyle lead’in hat durumu.
​
createdMembers[].role
string
Üyeye atanan rol adı — "client" olacaktır.
Tek bir API çağrısında birden fazla lead oluşturmak için diziye birden fazla lead nesnesi iletebilirsiniz. Her nesne, kendine özgü benzersiz e-posta adresiyle birlikte tüm zorunlu alanları içermelidir.