Langsung ke konten utama
Endpoint Create Client memungkinkan Anda menambahkan klien langsung ke workspace AgencyHandy dari sistem eksternal. Tidak seperti lead, klien adalah kontak yang sepenuhnya terdaftar dan dapat ditetapkan ke pesanan, tagihan, dan proyek. Gunakan endpoint ini untuk menyinkronkan klien baru dari CRM, formulir orientasi, atau sumber data lainnya.
Sebelum menggunakan endpoint ini, selesaikan panduan Memulai untuk mendapatkan API key dan Company ID Anda. Tidak seperti endpoint Create Lead, membuat klien tidak memerlukan langkah pencarian Role ID terpisah.

​
Prasyarat

  • ✅ API key yang dibuat dari Workspace Config → API Key
  • ✅ Company ID yang diambil dari GET {{URL}}/accounts/companies

​
Endpoint

POST {{URL}}/members/bulk-client
HeaderNilai
x-api-keyAPI key Anda
companyIdCompany ID Anda
Content-Typeapplication/json

​
Isi permintaan

Isi permintaan adalah array JSON. Anda dapat membuat satu atau lebih klien dalam satu permintaan.
​
firstName
string
wajib
Nama depan klien.
​
lastName
string
wajib
Nama belakang klien.
​
email
string
wajib
Alamat email klien. Harus unik dalam workspace Anda.
​
isConvertedClient
boolean
wajib
Atur ke false untuk klien yang benar-benar baru. Atur ke true saat mengonversi lead yang ada menjadi klien.
​
status
string
Status klien. Nilai umum: New, Active. Default ke New jika dihilangkan.
​
contactNo
string
Nomor telepon klien.
​
source
string
Cara Anda mendapatkan klien ini. Contoh nilai: website, referral, social.
​
positionInBoard
number
Posisi klien dalam kolom papan. Default ke 1.

​
Contoh permintaan

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

​
Respons sukses

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
String konfirmasi saat berhasil.
​
createdMembers
array
Array objek klien yang telah dibuat.
​
createdMembers[].\_id
string
ID unik dari klien yang baru dibuat. Gunakan ID ini saat menetapkan klien ke pesanan atau tagihan melalui API.
​
createdMembers[].name
string
Nama lengkap klien (firstName + lastName).
​
createdMembers[].status
string
Status klien yang tersimpan.
​
createdMembers[].role
string
Peran yang ditetapkan ke anggota — akan menjadi "client".
Header companyId untuk endpoint ini menggunakan huruf kapital I dalam Id — companyId — tidak seperti beberapa endpoint lain yang menggunakan companyid (semua huruf kecil). Gunakan kapitalisasi persis seperti yang ditunjukkan di atas untuk menghindari kesalahan autentikasi.
Teruskan beberapa objek klien dalam array untuk membuat klien secara massal dalam satu panggilan API. Setiap objek harus memiliki alamat email yang unik. Email duplikat akan menyebabkan kesalahan validasi untuk entri tersebut.