Pāriet uz galveno saturu
Klienta izveides galapunkts ļauj pievienot klientus tieši jūsu AgencyHandy darbvietai no ārējas sistēmas. Atšķirībā no potenciālajiem klientiem (leads), klienti ir pilnībā pievienoti kontakti, kurus var piešķirt pasūtījumiem, rēķiniem un projektiem. Izmantojiet šo galapunktu, lai sinhronizētu jaunus klientus no CRM, reģistrācijas veidlapas vai cita datu avota.
Pirms šī galapunkta izmantošanas izpildiet rokasgrāmatu Darba sākšana, lai iegūtu API atslēgu un uzņēmuma ID. Atšķirībā no potenciālā klienta izveides galapunkta, klienta izveidei nav nepieciešams atsevišķs lomas ID uzmeklēšanas solis.

​
Priekšnosacījumi

  • ✅ API atslēga ģenerēta no Workspace Config → API Key
  • ✅ Uzņēmuma ID iegūts no GET {{URL}}/accounts/companies

​
Galapunkts

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

​
Galvenes

GalveneVērtība
x-api-keyJūsu API atslēga
companyIdJūsu uzņēmuma ID
Content-Typeapplication/json

​
Pieprasījuma pamatteksts

Pieprasījuma pamatteksts ir JSON masīvs. Vienā pieprasījumā varat izveidot vienu vai vairākus klientus.
​
firstName
string
obligāts
Klienta vārds.
​
lastName
string
obligāts
Klienta uzvārds.
​
email
string
obligāts
Klienta e-pasta adrese. Jābūt unikālai jūsu darbvietā.
​
isConvertedClient
boolean
obligāts
Jaunam klientam iestatiet uz false. Iestatiet uz true, konvertējot esošu potenciālo klientu par klientu.
​
status
string
Klienta statuss. Izplatītas vērtības: New, Active. Noklusējums ir New, ja izlaists.
​
contactNo
string
Klienta tālruņa numurs.
​
source
string
Kā iegūts šis klients. Piemēra vērtības: website, referral, social.
​
positionInBoard
number
Klienta pozīcija paneļa kolonnā. Noklusējums ir 1.

​
Piemēra pieprasījums

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

​
Veiksmīga atbilde

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Apstiprinājuma virkne veiksmīgas darbības gadījumā.
​
createdMembers
array
Izveidoto klientu objektu masīvs.
​
createdMembers[].\_id
string
Jaunizveidotā klienta unikālais ID. Izmantojiet šo ID, piešķirot klientu pasūtījumiem vai rēķiniem, izmantojot API.
​
createdMembers[].name
string
Klienta pilnais vārds (vārds + uzvārds).
​
createdMembers[].status
string
Saglabātais klienta statuss.
​
createdMembers[].role
string
Dalībniekam piešķirtā loma — būs "client".
Šī galapunkta companyId galvenē tiek izmantots lielais burts I — companyId — atšķirībā no dažiem citiem galapunktiem, kas izmanto companyid (visi mazie burti). Izmantojiet precīzu lielo/mazo burtu rakstību, kas norādīta iepriekš, lai izvairītos no autentifikācijas kļūdām.
Masīvā nododiet vairākus klientu objektus, lai vienā API izsaukumā lielapjoma veidā izveidotu klientus. Katram objektam jābūt unikālai email adresei. Dublētās e-pasta adreses izraisīs validācijas kļūdu attiecīgajam ierakstam.