Pāriet uz galveno saturu
Potenciālā klienta izveides galapunkts ļauj programmatiskā veidā pievienot jaunus potenciālos klientus (leads) savai AgencyHandy darbvietai no jebkuras ārējas sistēmas — tīmekļa veidlapas, CRM, mārketinga automatizācijas platformas vai pielāgota skripta. Caur šo galapunktu izveidotie potenciālie klienti nekavējoties parādās jūsu potenciālo klientu konveijerā, tāpat kā manuāli pievienotie.
Pirms šī galapunkta izmantošanas izpildiet rokasgrāmatu Darba sākšana, lai iegūtu API atslēgu un uzņēmuma ID. Jums arī jāiegūst klienta lomas ID, kas ir nepieciešams, veidojot potenciālo klientu.

​
Priekšnosacījumi

  • ✅ API atslēga ģenerēta no Workspace Config → API Key
  • ✅ Uzņēmuma ID iegūts no GET {{URL}}/accounts/companies
  • ✅ Klienta lomas ID iegūts (skatiet 1. darbību zemāk)

​
1. darbība: iegūt klienta lomas ID

Pirms potenciālā klienta izveides jums ir nepieciešams lomas ID client lomai jūsu uzņēmumā.

​
Galapunkts

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

​
Galvenes

GalveneVērtība
x-api-keyJūsu API atslēga
companyidJūsu uzņēmuma ID

​
Piemēra pieprasījums

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

​
Piemēra atbilde

{
  "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"
    }
  ]
}
Atrodiet ierakstu, kur roles[0].role.name === "client", un izvelciet ārējo _id — tas ir roles[0]._id, nevis roles[0].role._id. 
const clientRoleId = roles.find(r => r.role.name === "client")._id;
// e.g. "6525994184e9ddd798534535"
Izmantojiet roles[0]._id (uzņēmuma-lomas kartējuma ID), nevis roles[0].role._id (lomas definīcijas ID). Nepareiza ID izmantošana izraisa potenciālā klienta izveides pieprasījuma kļūdu.

​
2. darbība: izveidot jaunu potenciālo klientu

​
Galapunkts

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

​
Galvenes

GalveneVērtība
x-api-keyJūsu API atslēga
companyidJūsu uzņēmuma ID
Content-Typeapplication/json

​
Pieprasījuma pamatteksts

Pieprasījuma pamatteksts ir JSON masīvs — vienā izsaukumā var izveidot vienu vai vairākus potenciālos klientus.
​
firstName
string
obligāts
Potenciālā klienta vārds.
​
lastName
string
obligāts
Potenciālā klienta uzvārds.
​
email
string
obligāts
Potenciālā klienta e-pasta adrese. Jābūt unikālai jūsu darbvietā.
​
role
string
obligāts
Klienta lomas ID, kas iegūts 1. darbībā (t.i., roles[0]._id).
​
isConvertedClient
boolean
obligāts
Veidojot potenciālo klientu, jāiestata uz false. Iestatiet uz true tikai konvertējot potenciālo klientu par pilnvērtīgu klientu.
​
status
string
Potenciālā klienta konveijera statuss. Izplatītas vērtības: New, Contacted, Qualified. Noklusējums ir New, ja izlaists.
​
contactNo
string
Potenciālā klienta tālruņa numurs.
​
source
string
Kā iegūts šis potenciālais klients. Piemēra vērtības: website, referral, social.
​
positionInBoard
number
Potenciālā klienta pozīcija (kārtība) konveijera paneļa kolonnā. Noklusējums ir 1.

​
Piemēra pieprasījums

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

​
Veiksmīga atbilde

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Apstiprinājuma virkne: "Lead created successfully".
​
createdMembers
array
Izveidoto potenciālo klientu objektu masīvs.
​
createdMembers[].\_id
string
Jaunizveidotā potenciālā klienta unikālais ID. Saglabājiet to, ja nepieciešams atsaukties uz potenciālo klientu turpmākajos API izsaukumos.
​
createdMembers[].name
string
Potenciālā klienta pilnais vārds (vārds + uzvārds).
​
createdMembers[].status
string
Saglabātais potenciālā klienta konveijera statuss.
​
createdMembers[].role
string
Dalībniekam piešķirtās lomas nosaukums — būs "client".
Masīvā varat nodot vairākus potenciālo klientu objektus, lai vienā API izsaukumā izveidotu vairākus potenciālos klientus. Katram objektam jāiekļauj visi obligātie lauki ar savu unikālo e-pasta adresi.