Spring til hovedindhold
Opret lead-endpointet lader dig programmatisk tilføje nye leads til dit AgencyHandy-workspace fra ethvert eksternt system — en webformular, et CRM, en marketingautomatiseringsplatform eller et brugerdefineret script. Leads oprettet via dette endpoint vises straks i din lead-pipeline, ligesom hvis de var tilføjet manuelt.
Inden du bruger dette endpoint, skal du fuldføre vejledningen Kom godt i gang for at hente din API-nøgle og dit Company ID. Du skal også hente dit Client Role ID, som er påkrævet ved oprettelse af en lead.

​
Forudsætninger

  • ✅ API-nøgle genereret fra Workspace Config → API Key
  • ✅ Company ID hentet fra GET {{URL}}/accounts/companies
  • ✅ Client Role ID hentet (se Trin 1 nedenfor)

​
Trin 1: Hent Client Role ID

Inden du opretter en lead, skal du bruge Role ID for client-rollen i dit bureau.

​
Endpoint

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

​
Headers

HeaderVærdi
x-api-keyDin API-nøgle
companyidDit Company ID

​
Eksempelanmodning

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

​
Eksempelsvar

{
  "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"
    }
  ]
}
Find den post, hvor roles[0].role.name === "client", og udpak det ydre _id — det er roles[0]._id, ikke roles[0].role._id. 
const clientRoleId = roles.find(r => r.role.name === "client")._id;
// e.g. "6525994184e9ddd798534535"
Brug roles[0]._id (bureau-rolle-tilknytnings-ID’et), ikke roles[0].role._id (rolle-definitions-ID’et). Brug af det forkerte ID medfører, at lead-oprettelsesanmodningen mislykkes.

​
Trin 2: Opret en ny lead

​
Endpoint

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

​
Headers

HeaderVærdi
x-api-keyDin API-nøgle
companyidDit Company ID
Content-Typeapplication/json

​
Anmodningskrop

Anmodningskroppen er et JSON-array — du kan oprette én eller flere leads i et enkelt kald.
​
firstName
string
påkrævet
Leadens fornavn.
​
lastName
string
påkrævet
Leadens efternavn.
​
email
string
påkrævet
Leadens e-mailadresse. Skal være unik inden for dit workspace.
​
role
string
påkrævet
Client Role ID hentet i Trin 1 (dvs. roles[0]._id).
​
isConvertedClient
boolean
påkrævet
Skal sættes til false ved oprettelse af en lead. Sæt til true kun når du konverterer en lead til en fuld klient.
​
status
string
Leadens pipeline-status. Almindelige værdier: New, Contacted, Qualified. Standardværdi er New, hvis udeladt.
​
contactNo
string
Leadens telefonnummer.
​
source
string
Hvordan du erhvervede denne lead. Eksempelværdier: website, referral, social.
​
positionInBoard
number
Leadens position (rækkefølge) inden for pipeline-boardkolonnen. Standardværdi er 1.

​
Eksempelanmodning

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

​
Succesfuldt svar

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bekræftelsesstreng: "Lead created successfully".
​
createdMembers
array
Array af oprettede lead-objekter.
​
createdMembers[].\_id
string
Det unikke ID for den nyoprettede lead. Gem dette, hvis du skal referere til leaden i efterfølgende API-kald.
​
createdMembers[].name
string
Leadens fulde navn (fornavn + efternavn).
​
createdMembers[].status
string
Leadens pipeline-status som gemt.
​
createdMembers[].role
string
Rollenavnet tildelt til medlemmet — vil være "client".
Du kan sende flere lead-objekter i arrayet for at oprette flere leads i et enkelt API-kald. Hvert objekt skal inkludere alle påkrævede felter med sin egen unikke e-mailadresse.