Hopp til hovedinnhold
Opprett klient-endepunktet lar deg legge til klienter direkte i AgencyHandy-arbeidsområdet ditt fra et eksternt system. I motsetning til leads er klienter fullstendig ombordsteg-kontakter som kan tilordnes bestillinger, fakturaer og prosjekter. Bruk dette endepunktet til å synkronisere nye klienter fra et CRM, et onboarding-skjema eller en annen datakilde.
Før du bruker dette endepunktet, fullfør guiden Kom i gang for å hente API-nøkkelen og bedrifts-ID-en din. I motsetning til Opprett lead-endepunktet krever ikke opprettelse av en klient et eget oppslagstrinn for Rolle-ID.

​
Forutsetninger

  • ✅ API-nøkkel generert fra Arbeidsområdekonfigurasjon → API-nøkkel
  • ✅ Bedrifts-ID hentet fra GET {{URL}}/accounts/companies

​
Endepunkt

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

​
Overskrifter

OverskriftVerdi
x-api-keyAPI-nøkkelen din
companyIdBedrifts-ID-en din
Content-Typeapplication/json

​
Forespørselskropp

Forespørselskroppen er en JSON-array. Du kan opprette én eller flere klienter i én enkelt forespørsel.
​
firstName
string
påkrevd
Klientens fornavn.
​
lastName
string
påkrevd
Klientens etternavn.
​
email
string
påkrevd
Klientens e-postadresse. Må være unik i arbeidsområdet ditt.
​
isConvertedClient
boolean
påkrevd
Sett til false for en helt ny klient. Sett til true når du konverterer en eksisterende lead til en klient.
​
status
string
Klientens status. Vanlige verdier: New, Active. Standardverdi er New hvis utelatt.
​
contactNo
string
Klientens telefonnummer.
​
source
string
Hvordan du anskaffet denne klienten. Eksempelverdier: website, referral, social.
​
positionInBoard
number
Klientens posisjon i brettsøylen. Standardverdi er 1.

​
Eksempelforespørsel

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

​
Vellykket svar

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bekreftelsesstreng ved suksess.
​
createdMembers
array
Array av opprettede klientobjekter.
​
createdMembers[].\_id
string
Unik ID for den nyopprettede klienten. Bruk denne ID-en når du tilordner klienten til bestillinger eller fakturaer via API-et.
​
createdMembers[].name
string
Fullt navn på klienten (fornavn + etternavn).
​
createdMembers[].status
string
Statusen til klienten slik den er lagret.
​
createdMembers[].role
string
Rollen tildelt medlemmet — vil være "client".
companyId-overskriften for dette endepunktet bruker stor I i Id — companyId — i motsetning til noen andre endepunkter som bruker companyid (kun små bokstaver). Bruk den nøyaktige skrivemåten vist ovenfor for å unngå autentiseringsfeil.
Send inn flere klientobjekter i arrayet for å masseopprett klienter i ett enkelt API-kall. Hvert objekt må ha en unik email-adresse. Dupliserte e-poster vil forårsake en valideringsfeil for den oppføringen.