Naar hoofdinhoud gaan
Met het eindpunt Klant aanmaken kunt u klanten rechtstreeks vanuit een extern systeem toevoegen aan uw AgencyHandy-werkruimte. In tegenstelling tot leads zijn klanten volledig geonboardde contacten die kunnen worden toegewezen aan bestellingen, facturen en projecten. Gebruik dit eindpunt om nieuwe klanten te synchroniseren vanuit een CRM, onboardingformulier of een andere gegevensbron.
Voltooi voordat u dit eindpunt gebruikt de gids Aan de Slag om uw API-sleutel en Bedrijfs-ID te verkrijgen. In tegenstelling tot het eindpunt Lead aanmaken vereist het aanmaken van een klant geen afzonderlijke stap voor het opzoeken van een Rol-ID.

​
Vereisten

  • ✅ API-sleutel gegenereerd vanuit Werkruimteconfiguratie → API-sleutel
  • ✅ Bedrijfs-ID opgehaald via GET {{URL}}/accounts/companies

​
Eindpunt

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

​
Headers

HeaderWaarde
x-api-keyUw API-sleutel
companyIdUw Bedrijfs-ID
Content-Typeapplication/json

​
Verzoekbody

De verzoekbody is een JSON-array. U kunt één of meer klanten aanmaken in één verzoek.
​
firstName
string
vereist
De voornaam van de klant.
​
lastName
string
vereist
De achternaam van de klant.
​
email
string
vereist
Het e-mailadres van de klant. Moet uniek zijn binnen uw werkruimte.
​
isConvertedClient
boolean
vereist
Stel in op false voor een gloednieuwe klant. Stel in op true bij het converteren van een bestaande lead naar een klant.
​
status
string
De status van de klant. Veelgebruikte waarden: New, Active. Standaard New indien weggelaten.
​
contactNo
string
Het telefoonnummer van de klant.
​
source
string
Hoe u deze klant heeft verkregen. Voorbeeldwaarden: website, referral, social.
​
positionInBoard
number
De positie van de klant binnen de bordkolom. Standaard 1.

​
Voorbeeldverzoek

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

​
Succesantwoord

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bevestigingsreeks bij succes.
​
createdMembers
array
Array van aangemaakte klant-objecten.
​
createdMembers[].\_id
string
Uniek ID van de nieuw aangemaakte klant. Gebruik dit ID bij het toewijzen van de klant aan bestellingen of facturen via de API.
​
createdMembers[].name
string
De volledige naam van de klant (voornaam + achternaam).
​
createdMembers[].status
string
De status van de klant zoals opgeslagen.
​
createdMembers[].role
string
De rol toegewezen aan het lid — wordt "client".
De companyId-header voor dit eindpunt gebruikt een hoofdletter I in Id — companyId — in tegenstelling tot sommige andere eindpunten die companyid gebruiken (volledig kleine letters). Gebruik de exacte schrijfwijze zoals hierboven weergegeven om authenticatiefouten te vermijden.
Geef meerdere klant-objecten door in de array om klanten in bulk aan te maken in één API-aanroep. Elk object moet een uniek email-adres hebben. Dubbele e-mailadressen veroorzaken een validatiefout voor dat item.