Přejít na hlavní obsah
Endpoint pro vytvoření klienta umožňuje přidávat klienty přímo do vašeho workspace AgencyHandy z externího systému. Na rozdíl od leadů jsou klienti plnohodnotně zaregistrované kontakty, které lze přiřazovat k objednávkám, fakturám a projektům. Pomocí tohoto endpointu synchronizujte nové klienty z CRM, onboardingového formuláře nebo jiného datového zdroje.
Před použitím tohoto endpointu dokončete průvodce Začínáme a získejte svůj API klíč a ID společnosti. Na rozdíl od endpointu pro vytvoření leadu vytvoření klienta nevyžaduje samostatný krok vyhledání ID role.

​
Předpoklady

  • ✅ API klíč vygenerovaný z Konfigurace workspace → API klíč
  • ✅ ID společnosti získané z GET {{URL}}/accounts/companies

​
Endpoint

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

​
Hlavičky

HlavičkaHodnota
x-api-keyVáš API klíč
companyIdVaše ID společnosti
Content-Typeapplication/json

​
Tělo požadavku

Tělo požadavku je JSON pole. V jednom požadavku můžete vytvořit jednoho nebo více klientů.
​
firstName
string
povinné
Křestní jméno klienta.
​
lastName
string
povinné
Příjmení klienta.
​
email
string
povinné
E-mailová adresa klienta. Musí být jedinečná v rámci vašeho workspace.
​
isConvertedClient
boolean
povinné
Pro zcela nového klienta nastavte na false. Nastavte na true při převodu stávajícího leadu na klienta.
​
status
string
Stav klienta. Běžné hodnoty: New, Active. Výchozí hodnota je New, pokud není zadáno.
​
contactNo
string
Telefonní číslo klienta.
​
source
string
Způsob získání tohoto klienta. Příklady hodnot: website, referral, social.
​
positionInBoard
number
Pozice klienta ve sloupci nástěnky. Výchozí hodnota je 1.

​
Ukázkový požadavek

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

​
Odpověď při úspěchu

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Potvrzovací řetězec při úspěchu.
​
createdMembers
array
Pole vytvořených objektů klientů.
​
createdMembers[].\_id
string
Jedinečné ID nově vytvořeného klienta. Toto ID použijte při přiřazování klienta k objednávkám nebo fakturám prostřednictvím API.
​
createdMembers[].name
string
Celé jméno klienta (křestní jméno + příjmení).
​
createdMembers[].status
string
Stav klienta tak, jak je uložen.
​
createdMembers[].role
string
Role přiřazená členovi — bude "client".
Hlavička companyId pro tento endpoint používá velké I v Id — companyId — na rozdíl od některých jiných endpointů, které používají companyid (vše malými písmeny). Použijte přesné psaní uvedené výše, abyste předešli chybám ověřování.
Předejte více objektů klientů v poli a vytvořte tak klienty hromadně v jednom volání API. Každý objekt musí mít jedinečnou email adresu. Duplicitní e-maily způsobí chybu ověření pro daný záznam.