Siirry pääsisältöön
Luo asiakas -päätepiste antaa sinun lisätä asiakkaita suoraan AgencyHandy-työtilaan ulkoisesta järjestelmästä. Toisin kuin liidit, asiakkaat ovat täysin käyttöönottettuja yhteystietoja, jotka voidaan osoittaa tilauksiin, laskuihin ja projekteihin. Käytä tätä päätepistettä uusien asiakkaiden synkronointiin CRM-järjestelmästä, käyttöönottolomakkeesta tai muusta tietolähteestä.
Ennen tämän päätepisteen käyttämistä, suorita Aloittaminen -opas API-avaimen ja yritystunnuksen hankkimiseksi. Toisin kuin Luo liidi -päätepiste, asiakkaan luominen ei edellytä erillistä Role ID:n hakuvaihetta.

​
Edellytykset

  • ✅ API-avain luotu kohdasta Workspace Config → API Key
  • ✅ Yritystunnus haettu kohteesta GET {{URL}}/accounts/companies

​
Päätepiste

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

​
Otsikot

OtsikkoArvo
x-api-keyAPI-avaimesi
companyIdYritystunnuksesi
Content-Typeapplication/json

​
Pyynnön runko

Pyynnön runko on JSON-taulukko. Voit luoda yhden tai useamman asiakkaan yhdellä pyynnöllä.
​
firstName
string
vaadittu
Asiakkaan etunimi.
​
lastName
string
vaadittu
Asiakkaan sukunimi.
​
email
string
vaadittu
Asiakkaan sähköpostiosoite. On oltava yksilöllinen työtilasi sisällä.
​
isConvertedClient
boolean
vaadittu
Aseta false kokonaan uudelle asiakkaalle. Aseta true muuntaessasi olemassa olevan liidin asiakkaaksi.
​
status
string
Asiakkaan tila. Yleiset arvot: New, Active. Oletus on New, jos jätetään pois.
​
contactNo
string
Asiakkaan puhelinnumero.
​
source
string
Miten hankit tämän asiakkaan. Esimerkkiarvot: website, referral, social.
​
positionInBoard
number
Asiakkaan sijainti taulun sarakkeessa. Oletus on 1.

​
Esimerkkipyyntö

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

​
Onnistumisvastaus

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Vahvistusmerkkijono onnistumisen yhteydessä.
​
createdMembers
array
Luotujen asiakasobjektien taulukko.
​
createdMembers[].\_id
string
Äskettäin luodun asiakkaan yksilöllinen tunnus. Käytä tätä tunnusta asiakkaan osoittamiseen tilauksiin tai laskuihin API:n kautta.
​
createdMembers[].name
string
Asiakkaan koko nimi (etunimi + sukunimi).
​
createdMembers[].status
string
Asiakkaan tila tallennettuna.
​
createdMembers[].role
string
Jäsenelle osoitettu rooli — on "client".
Tämän päätepisteen companyId-otsikossa käytetään isoa I-kirjainta muodossa Id — companyId — toisin kuin joissakin muissa päätepisteissä, joissa käytetään companyid (kaikki pieniä kirjaimia). Käytä yllä näytettyä tarkkaa kirjainkokoa todentamisvirheiden välttämiseksi.
Välitä useita asiakasobjekteja taulukossa luodaksesi asiakkaita joukottain yhdellä API-kutsulla. Jokaisella objektilla on oltava yksilöllinen email-osoite. Päällekkäiset sähköpostit aiheuttavat vahvistusvirheen kyseiselle merkinnälle.