Hoppa till huvudinnehåll
Endpointen Skapa klient låter dig lägga till klienter direkt till din AgencyHandy-arbetsyta från ett externt system. Till skillnad från leads är klienter fullständigt registrerade kontakter som kan tilldelas beställningar, fakturor och projekt. Använd denna endpoint för att synkronisera nya klienter från ett CRM, ett registreringsformulär eller någon annan datakälla.
Innan du använder denna endpoint, slutför guiden Kom igång för att skaffa din API-nyckel och ditt företags-ID. Till skillnad från endpointen Skapa lead kräver skapandet av en klient inte ett separat steg för att hämta roll-ID.

​
Förutsättningar

  • ✅ API-nyckel genererad från Arbetsytekonfiguration → API-nyckel
  • ✅ Företags-ID hämtat från GET {{URL}}/accounts/companies

​
Endpoint

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

​
Huvuden

HuvudVärde
x-api-keyDin API-nyckel
companyIdDitt företags-ID
Content-Typeapplication/json

​
Begärandekropp

Begärandekroppen är en JSON-array. Du kan skapa en eller flera klienter i en enda begäran.
​
firstName
string
obligatorisk
Klientens förnamn.
​
lastName
string
obligatorisk
Klientens efternamn.
​
email
string
obligatorisk
Klientens e-postadress. Måste vara unik inom din arbetsyta.
​
isConvertedClient
boolean
obligatorisk
Sätt till false för en helt ny klient. Sätt till true när du konverterar en befintlig lead till en klient.
​
status
string
Klientens status. Vanliga värden: New, Active. Standardvärdet är New om det utelämnas.
​
contactNo
string
Klientens telefonnummer.
​
source
string
Hur du fick tag på denna klient. Exempelvärden: website, referral, social.
​
positionInBoard
number
Klientens position inom boardkolumnen. Standardvärdet är 1.

​
Exempelbegäran

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

​
Lyckat svar

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bekräftelsesträng vid lyckat resultat.
​
createdMembers
array
Array med skapade klientobjekt.
​
createdMembers[].\_id
string
Unikt ID för den nyligen skapade klienten. Använd detta ID när du tilldelar klienten till beställningar eller fakturor via API:et.
​
createdMembers[].name
string
Klientens fullständiga namn (förnamn + efternamn).
​
createdMembers[].status
string
Klientens status som den lagrats.
​
createdMembers[].role
string
Rollen tilldelad till medlemmen — kommer att vara "client".
companyId-huvudet för denna endpoint använder ett stort I i Id — companyId — till skillnad från vissa andra endpoints som använder companyid (allt med gemener). Använd exakt den skrivning som visas ovan för att undvika autentiseringsfel.
Skicka flera klientobjekt i arrayen för att bulk-skapa klienter i ett enda API-anrop. Varje objekt måste ha en unik email-adress. Duplicerade e-postadresser orsakar ett valideringsfel för den posten.