Hopp til hovedinnhold
Opprett lead-endepunktet lar deg programmatisk legge til nye leads i AgencyHandy-arbeidsområdet ditt fra et hvilket som helst eksternt system — et nettskjema, et CRM, en markedsføringsautomatiseringsplattform eller et egendefinert skript. Leads opprettet via dette endepunktet vises umiddelbart i leadpipelinen din, akkurat som om de ble lagt til manuelt.
Før du bruker dette endepunktet, fullfør guiden Kom i gang for å hente API-nøkkelen og bedrifts-ID-en din. Du trenger også å hente klientrolle-ID-en, som er påkrevd når du oppretter en lead.

​
Forutsetninger

  • ✅ API-nøkkel generert fra Arbeidsområdekonfigurasjon → API-nøkkel
  • ✅ Bedrifts-ID hentet fra GET {{URL}}/accounts/companies
  • ✅ Klientrolle-ID hentet (se Trinn 1 nedenfor)

​
Trinn 1: Hent klientrolle-ID-en

Før du oppretter en lead, trenger du rolle-ID-en for client-rollen i bedriften din.

​
Endepunkt

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

​
Overskrifter

OverskriftVerdi
x-api-keyAPI-nøkkelen din
companyidBedrifts-ID-en din

​
Eksempelforespørsel

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"
    }
  ]
}
Finn oppføringen der roles[0].role.name === "client" og trekk ut den ytre _id — det er roles[0]._id, ikke roles[0].role._id. 
const clientRoleId = roles.find(r => r.role.name === "client")._id;
// e.g. "6525994184e9ddd798534535"
Bruk roles[0]._id (bedriftsrolle-tilknytnings-ID-en), ikke roles[0].role._id (rolledefinisjonens ID). Å bruke feil ID fører til at lead-opprettelsesforespørselen mislykkes.

​
Trinn 2: Opprett en ny lead

​
Endepunkt

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

​
Overskrifter

OverskriftVerdi
x-api-keyAPI-nøkkelen din
companyidBedrifts-ID-en din
Content-Typeapplication/json

​
Forespørselskropp

Forespørselskroppen er en JSON-array — du kan opprette én eller flere leads i ett enkelt kall.
​
firstName
string
påkrevd
Leadens fornavn.
​
lastName
string
påkrevd
Leadens etternavn.
​
email
string
påkrevd
Leadens e-postadresse. Må være unik i arbeidsområdet ditt.
​
role
string
påkrevd
Klientrolle-ID-en hentet i Trinn 1 (dvs. roles[0]._id).
​
isConvertedClient
boolean
påkrevd
Må settes til false når du oppretter en lead. Sett til true bare når du konverterer en lead til en fullstendig klient.
​
status
string
Leadens pipelinestatus. Vanlige verdier: New, Contacted, Qualified. Standardverdi er New hvis utelatt.
​
contactNo
string
Leadens telefonnummer.
​
source
string
Hvordan du anskaffet denne leaden. Eksempelverdier: website, referral, social.
​
positionInBoard
number
Leadens posisjon (rekkefølge) i pipeline-brettsøylen. Standardverdi er 1.

​
Eksempelforespørsel

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

​
Vellykket svar

{
  "message": "Lead created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Bekreftelsesstreng: "Lead created successfully".
​
createdMembers
array
Array av opprettede lead-objekter.
​
createdMembers[].\_id
string
Den unike ID-en til den nyopprettede leaden. Lagre denne hvis du trenger å referere til leaden i påfølgende API-kall.
​
createdMembers[].name
string
Fullt navn på leaden (fornavn + etternavn).
​
createdMembers[].status
string
Pipelinestatusen til leaden slik den er lagret.
​
createdMembers[].role
string
Rollenavnet tildelt medlemmet — vil være "client".
Du kan sende inn flere lead-objekter i arrayet for å opprette flere leads i ett enkelt API-kall. Hvert objekt må inkludere alle påkrevde felt med sin egen unike e-postadresse.