Spring til hovedindhold
Opret klient-endpointet lader dig tilføje klienter direkte til dit AgencyHandy-workspace fra et eksternt system. I modsætning til leads er klienter fuldt onboardede kontakter, der kan tildeles ordrer, fakturaer og projekter. Brug dette endpoint til at synkronisere nye klienter fra et CRM, en onboardingformular eller en anden datakilde.
Inden du bruger dette endpoint, skal du fuldføre vejledningen Kom godt i gang for at hente din API-nøgle og dit Company ID. I modsætning til Opret lead-endpointet kræver oprettelse af en klient ikke et separat opslag af Role ID.

​
Forudsætninger

  • ✅ API-nøgle genereret fra Workspace Config → API Key
  • ✅ Company ID hentet fra GET {{URL}}/accounts/companies

​
Endpoint

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

​
Headers

HeaderVærdi
x-api-keyDin API-nøgle
companyIdDit Company ID
Content-Typeapplication/json

​
Anmodningskrop

Anmodningskroppen er et JSON-array. Du kan oprette én eller flere klienter i en enkelt anmodning.
​
firstName
string
påkrævet
Klientens fornavn.
​
lastName
string
påkrævet
Klientens efternavn.
​
email
string
påkrævet
Klientens e-mailadresse. Skal være unik inden for dit workspace.
​
isConvertedClient
boolean
påkrævet
Sæt til false for en helt ny klient. Sæt til true ved konvertering af en eksisterende lead til en klient.
​
status
string
Klientens status. Almindelige værdier: New, Active. Standardværdi er New, hvis udeladt.
​
contactNo
string
Klientens telefonnummer.
​
source
string
Hvordan du erhvervede denne klient. Eksempelværdier: website, referral, social.
​
positionInBoard
number
Klientens position inden for boardkolonnen. Standardværdi er 1.

​
Eksempelanmodning

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

​
Succesfuldt svar

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bekræftelsesstreng ved succes.
​
createdMembers
array
Array af oprettede klient-objekter.
​
createdMembers[].\_id
string
Unikt ID for den nyoprettede klient. Brug dette ID, når du tildeler klienten til ordrer eller fakturaer via API’en.
​
createdMembers[].name
string
Klientens fulde navn (fornavn + efternavn).
​
createdMembers[].status
string
Klientens status som gemt.
​
createdMembers[].role
string
Rollen tildelt til medlemmet — vil være "client".
companyId-headeren for dette endpoint bruger stort I i Id — companyId — i modsætning til nogle andre endpoints der bruger companyid (alt med små bogstaver). Brug den præcise skrivemåde vist ovenfor for at undgå godkendelsesfejl.
Send flere klient-objekter i arrayet for at masseoproette klienter i et enkelt API-kald. Hvert objekt skal have en unik email-adresse. Dublerede e-mails vil forårsage en valideringsfejl for den pågældende post.