Siirry pääsisältöön
Luo liidi -päätepiste antaa sinun lisätä uusia liidejä AgencyHandy-työtilaan ohjelmallisesti mistä tahansa ulkoisesta järjestelmästä — verkkolomakkeesta, CRM-järjestelmästä, markkinoinnin automaatioalustasta tai mukautetusta skriptistä. Tämän päätepisteen kautta luodut liidit näkyvät liidiputkessasi välittömästi, aivan kuin ne olisi lisätty manuaalisesti.
Ennen tämän päätepisteen käyttämistä, suorita Aloittaminen -opas API-avaimen ja yritystunnuksen hankkimiseksi. Tarvitset myös Client Role ID:n, jota tarvitaan liidin luomisessa.

​
Edellytykset

  • ✅ API-avain luotu kohdasta Workspace Config → API Key
  • ✅ Yritystunnus haettu kohteesta GET {{URL}}/accounts/companies
  • ✅ Client Role ID haettu (katso alla oleva Vaihe 1)

​
Vaihe 1: Hae Client Role ID

Ennen liidin luomista tarvitset yrityksesi client-roolin Role ID:n.

​
Päätepiste

GET {{URL}}/roles?type=company

​
Otsikot

OtsikkoArvo
x-api-keyAPI-avaimesi
companyidYritystunnuksesi

​
Esimerkkipyyntö

cURL
curl --request GET "https://api.agencyhandy.com/roles?type=company" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyid: <YOUR_COMPANY_ID>"

​
Esimerkkivastaus

{
  "roles": [
    {
      "_id": "6525994184e9ddd798534535",
      "role": {
        "_id": "6525994184e9ddd79853451e",
        "responsibility": "",
        "name": "client"
      },
      "company": "6525994184e9ddd79853450e",
      "createdAt": "2023-10-10T18:34:41.567Z",
      "updatedAt": "2024-10-01T07:28:48.340Z",
      "__v": 0,
      "type": "company"
    }
  ]
}
Etsi merkintä, jossa roles[0].role.name === "client", ja pura ulompi _id — eli roles[0]._id, ei roles[0].role._id. 
const clientRoleId = roles.find(r => r.role.name === "client")._id;
// e.g. "6525994184e9ddd798534535"
Käytä roles[0]._id:tä (yritysroolin kartoitustunnus), ei roles[0].role._id:tä (roolimäärityksen tunnus). Väärän tunnuksen käyttäminen aiheuttaa liidin luontipyynnön epäonnistumisen.

​
Vaihe 2: Luo uusi liidi

​
Päätepiste

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

​
Otsikot

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

​
Pyynnön runko

Pyynnön runko on JSON-taulukko — voit luoda yhden tai useamman liidin yhdellä kutsulla.
​
firstName
string
vaadittu
Liidin etunimi.
​
lastName
string
vaadittu
Liidin sukunimi.
​
email
string
vaadittu
Liidin sähköpostiosoite. On oltava yksilöllinen työtilasi sisällä.
​
role
string
vaadittu
Vaiheessa 1 haettu Client Role ID (eli roles[0]._id).
​
isConvertedClient
boolean
vaadittu
On asetettava false-arvoon liidin luomisen yhteydessä. Aseta true-arvoon vain, kun muunnat liidin täydeksi asiakkaaksi.
​
status
string
Liidin putkistatus. Yleiset arvot: New, Contacted, Qualified. Oletus on New, jos jätetään pois.
​
contactNo
string
Liidin puhelinnumero.
​
source
string
Miten hankit tämän liidin. Esimerkkiarvot: website, referral, social.
​
positionInBoard
number
Liidin sijainti (järjestys) putkitaulun sarakkeessa. Oletus on 1.

​
Esimerkkipyyntö

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-lead" \
  --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",
      "role": "6525994184e9ddd798534535",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

​
Onnistumisvastaus

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Vahvistusmerkkijono: "Lead created successfully".
​
createdMembers
array
Luotujen liidiobjektien taulukko.
​
createdMembers[].\_id
string
Äskettäin luodun liidin yksilöllinen tunnus. Tallenna tämä, jos sinun on viitattava liidiin myöhemmissä API-kutsuissa.
​
createdMembers[].name
string
Liidin koko nimi (etunimi + sukunimi).
​
createdMembers[].status
string
Liidin putkistatus tallennettuna.
​
createdMembers[].role
string
Jäsenelle osoitettu roolin nimi — on "client".
Voit välittää useita liidiobjekteja taulukossa luodaksesi useita liidejä yhdellä API-kutsulla. Jokaisella objektilla on oltava kaikki pakolliset kentät sekä oma yksilöllinen sähköpostiosoite.