Salt la conținutul principal
Endpoint-ul Creare Client vă permite să adăugați clienți direct în spațiul dvs. de lucru AgencyHandy dintr-un sistem extern. Spre deosebire de lead-uri, clienții sunt contacte complet integrate care pot fi atribuite comenzilor, facturilor și proiectelor. Utilizați acest endpoint pentru a sincroniza clienții noi dintr-un CRM, un formular de integrare sau orice altă sursă de date.
Înainte de a utiliza acest endpoint, parcurgeți ghidul Noțiuni de bază pentru a obține cheia API și ID-ul companiei. Spre deosebire de endpoint-ul Creare Lead, crearea unui client nu necesită un pas separat de căutare a ID-ului rolului.

​
Cerințe preliminare

  • ✅ Cheie API generată din Configurare spațiu de lucru → Cheie API
  • ✅ ID companie recuperat din GET {{URL}}/accounts/companies

​
Endpoint

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

​
Header-e

HeaderValoare
x-api-keyCheia dvs. API
companyIdID-ul companiei dvs.
Content-Typeapplication/json

​
Corpul solicitării

Corpul solicitării este un array JSON. Puteți crea unul sau mai mulți clienți într-o singură solicitare.
​
firstName
string
obligatoriu
Prenumele clientului.
​
lastName
string
obligatoriu
Numele de familie al clientului.
​
email
string
obligatoriu
Adresa de e-mail a clientului. Trebuie să fie unică în spațiul dvs. de lucru.
​
isConvertedClient
boolean
obligatoriu
Setați la false pentru un client complet nou. Setați la true la conversia unui lead existent într-un client.
​
status
string
Statusul clientului. Valori comune: New, Active. Implicit New dacă este omis.
​
contactNo
string
Numărul de telefon al clientului.
​
source
string
Cum ați achiziționat acest client. Exemple: website, referral, social.
​
positionInBoard
number
Poziția clientului în coloana panoului. Implicit 1.

​
Exemplu de solicitare

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

​
Răspuns de succes

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Șir de confirmare la succes.
​
createdMembers
array
Array de obiecte client create.
​
createdMembers[].\_id
string
ID-ul unic al clientului creat recent. Utilizați acest ID la atribuirea clientului comenzilor sau facturilor prin API.
​
createdMembers[].name
string
Numele complet al clientului (firstName + lastName).
​
createdMembers[].status
string
Statusul clientului așa cum este stocat.
​
createdMembers[].role
string
Rolul atribuit membrului — va fi "client".
Header-ul companyId pentru acest endpoint utilizează un I majuscul în Id — companyId — spre deosebire de alte endpoint-uri care utilizează companyid (totul cu litere mici). Utilizați scrierea exactă prezentată mai sus pentru a evita erorile de autentificare.
Transmiteți mai multe obiecte client în array pentru a crea în bloc clienți într-un singur apel API. Fiecare obiect trebuie să aibă o adresă email unică. E-mailurile duplicate vor cauza o eroare de validare pentru acea intrare.