Asosiy tarkibga o'tish
Mijoz yaratish endpointi tashqi tizimdan to’g’ridan-to’g’ri AgencyHandy ish muhitingizga mijozlar qo’shish imkonini beradi. Leadlardan farqli o’laroq, mijozlar buyurtmalar, hisob-fakturalar va loyihalarga tayinlanishi mumkin bo’lgan to’liq onboarding qilingan kontaktlardir. CRM, onboarding formasidan yoki boshqa istalgan ma’lumot manbai orqali yangi mijozlarni sinxronlash uchun ushbu endpointdan foydalaning.
Ushbu endpointdan foydalanishdan oldin, API kaliti va Kompaniya ID sini olish uchun Boshlash qo’llanmasini bajaring. Lead yaratish endpointidan farqli o’laroq, mijoz yaratish alohida Rol ID si qidirish qadamini talab qilmaydi.

Oldindan talab qilinadigan shartlar

  • Workspace Config → API Key dan yaratilgan API kaliti
  • GET {{URL}}/accounts/companies dan olingan Kompaniya ID si

Endpoint

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

Sarlavhalar

SarlavhaQiymat
x-api-keySizning API kalitingiz
companyIdSizning Kompaniya ID ingiz
Content-Typeapplication/json

So’rov tanasi

So’rov tanasi JSON massivi. Bitta so’rovda bir yoki bir nechta mijoz yaratish mumkin.
firstName
string
talab qilinadi
Mijozning ismi.
lastName
string
talab qilinadi
Mijozning familiyasi.
email
string
talab qilinadi
Mijozning elektron pochta manzili. Ish muhitingizda noyob bo’lishi kerak.
isConvertedClient
boolean
talab qilinadi
Yangi mijoz uchun false ga o’rnating. Mavjud leadni mijozga aylantirishda true ga o’rnating.
status
string
Mijozning holati. Keng tarqalgan qiymatlar: New, Active. O’tkazib yuborilsa New ga standart o’rnatiladi.
contactNo
string
Mijozning telefon raqami.
source
string
Ushbu mijozni qanday topganingiz. Namuna qiymatlari: website, referral, social.
positionInBoard
number
Mijozning taxta ustunidagi joylashuvi. Standart 1.

Namuna so’rov

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
    }
  ]'

Muvaffaqiyatli javob

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
message
string
Muvaffaqiyat bo’lganda tasdiqlash satri.
createdMembers
array
Yaratilgan mijoz obyektlari massivi.
createdMembers[].\_id
string
Yangi yaratilgan mijozning noyob ID si. API orqali buyurtmalar yoki hisob-fakturalarga mijozni tayinlashda ushbu ID dan foydalaning.
createdMembers[].name
string
Mijozning to’liq ismi (firstName + lastName).
createdMembers[].status
string
Saqlangan mijoz holati.
createdMembers[].role
string
A’zoga tayinlangan rol — "client" bo’ladi.
Ushbu endpoint uchun companyId sarlavhasi Id da katta I harfi ishlatadi — companyId — ba’zi boshqa endpointlar barcha kichik harfli companyid ishlatishidan farqli o’laroq. Autentifikatsiya xatolarini oldini olish uchun yuqorida ko’rsatilgan aniq yozuvdan foydalaning.
Bitta API chaqiruvida bir nechta mijoz yaratish uchun massivga bir nechta mijoz obyektini uzating. Har bir obyektning noyob email manzili bo’lishi kerak. Takroriy elektron pochtalar o’sha yozuv uchun tekshiruv xatosiga olib keladi.