Przejdź do głównej treści
Punkt końcowy tworzenia klienta umożliwia dodawanie klientów bezpośrednio do przestrzeni roboczej AgencyHandy z zewnętrznego systemu. W przeciwieństwie do leadów, klienci są w pełni onboardowanymi kontaktami, którym można przypisywać zamówienia, faktury i projekty. Użyj tego punktu końcowego, aby synchronizować nowych klientów z systemu CRM, formularza onboardingowego lub innego źródła danych.
Przed użyciem tego punktu końcowego ukończ przewodnik Pierwsze kroki, aby uzyskać klucz API i identyfikator firmy. W przeciwieństwie do punktu końcowego tworzenia leada, tworzenie klienta nie wymaga oddzielnego kroku wyszukiwania identyfikatora roli.

​
Wymagania wstępne

  • ✅ Klucz API wygenerowany z Konfiguracja przestrzeni roboczej → Klucz API
  • ✅ Identyfikator firmy pobrany z GET {{URL}}/accounts/companies

​
Punkt końcowy

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

​
Nagłówki

NagłówekWartość
x-api-keyTwój klucz API
companyIdTwój identyfikator firmy
Content-Typeapplication/json

​
Ciało żądania

Ciało żądania jest tablicą JSON. Możesz utworzyć jednego lub więcej klientów w jednym żądaniu.
​
firstName
string
wymagane
Imię klienta.
​
lastName
string
wymagane
Nazwisko klienta.
​
email
string
wymagane
Adres e-mail klienta. Musi być unikalny w obrębie Twojej przestrzeni roboczej.
​
isConvertedClient
boolean
wymagane
Ustaw na false dla zupełnie nowego klienta. Ustaw na true przy konwersji istniejącego leada na klienta.
​
status
string
Status klienta. Typowe wartości: New, Active. Domyślnie New, jeśli pominięte.
​
contactNo
string
Numer telefonu klienta.
​
source
string
Sposób pozyskania tego klienta. Przykładowe wartości: website, referral, social.
​
positionInBoard
number
Pozycja klienta w kolumnie tablicy. Domyślnie 1.

​
Przykładowe żądanie

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

​
Odpowiedź sukcesu

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Ciąg potwierdzający po sukcesie.
​
createdMembers
array
Tablica utworzonych obiektów klientów.
​
createdMembers[].\_id
string
Unikalny identyfikator nowo utworzonego klienta. Użyj tego identyfikatora przy przypisywaniu klienta do zamówień lub faktur przez API.
​
createdMembers[].name
string
Pełne imię i nazwisko klienta (imię + nazwisko).
​
createdMembers[].status
string
Status klienta, tak jak został zapisany.
​
createdMembers[].role
string
Rola przypisana do członka — będzie to "client".
Nagłówek companyId dla tego punktu końcowego używa wielkiej litery I w Id — companyId — w przeciwieństwie do niektórych innych punktów końcowych, które używają companyid (wszystkie małe litery). Użyj dokładnej wielkości liter podanej powyżej, aby uniknąć błędów uwierzytelniania.
Przekaż wiele obiektów klientów w tablicy, aby zbiorczo tworzyć klientów w jednym wywołaniu API. Każdy obiekt musi posiadać unikalny adres email. Zduplikowane adresy e-mail spowodują błąd walidacji dla danego wpisu.