Leads

Leads aanleveren

posthttps://aicquisitioncrm.nl/api/v2/leads

Recht: aanleveren. Ook bereikbaar als POST /api/inbound/leads.

Zet één lead (lead) of tot 100 leads (leads) in een campagne. Een lead wordt herkend aan zijn telefoonnummer: staat hij al in de campagne, dan komt er geen tweede bij maar een notitie bij de bestaande. Het antwoord geeft per lead terug wat er gebeurde, in de volgorde van het verzoek.

Per lead kan een afspraak mee die de lead zelf heeft geboekt; Aicquisition plant die dan in bij de closer. Zie Afspraken meesturen voor een uitgewerkt voorbeeld.

Verzoek

Body

organisatie_idstring · uuid
Mag weg: de sleutel bepaalt de werkruimte. Staat hij erin, dan moet hij kloppen.
campagne_idstring · uuidverplicht
Verplicht. Opzoeken met Campagnes opvragen.
lijst_idstring · uuid
De lijst waarin nieuwe leads landen. Zonder dit maken we er zelf een per maand en per sleutel.
leadobject
Velden tonen
- telefoonstringverplicht
  Verplicht. Een Nederlands nummer mag met voorloopnul (0612345678); een buitenlands nummer met landnummer (+32470123456). Hierop herkennen we een lead terug in de campagne.
- voornaamstring
- achternaamstring
- bedrijfstring
- functiestring
- emailstring
  Nodig voor de bevestiging als je een afspraak meestuurt.
- externe_idstring
  Jouw eigen id van deze lead. Komt terug in het antwoord.
- warmtestring
  Standaard koud; een lead die wordt heropend, wordt warm.
  Een van: koud, warm, heet
- notitiestring
  Komt als eerste notitie op de lead te staan.
- fasestring
  Waar een nieuwe lead begint; standaard nieuwe_leads. Met een afspraak erbij standaard binnengekomen (Afspraak ingepland). Een bestaande lead houdt zijn fase.
  Een van: nieuwe_leads, gebeld_1, gebeld_2, gebeld_3, gebeld_4, niet_bereikt, follow_up, follow_up_lang, binnengekomen
- afspraakobject
  Een afspraak die de lead zelf boekte, bijvoorbeeld via Calendly. Aicquisition maakt de videoruimte, zet de lead op Afspraak ingepland bij de closer en mailt de bevestiging met de deelnamelink.
  Velden tonen
  - idstringverplicht
    Verplicht. Jouw id van deze afspraak; bij Calendly de Invitee URI. Hetzelfde bericht nog eens geeft geen tweede afspraak.
  - startstring
    Verplicht bij een nieuwe of verzette afspraak. Begin met tijdzone.
  - duur_minuteninteger
    Standaard 30.
  - closer_emailstring
    Verplicht bij een nieuwe of verzette afspraak. Het e-mailadres waarmee de closer in Aicquisition inlogt; opzoeken met Team opvragen.
  - statusstring
    "geannuleerd" zegt de afspraak met deze id af; er wordt dan geen lead aangemaakt. Standaard gepland.
    Een van: gepland, geannuleerd
  - vervangt_idstring
    Bij een verzetting: de id van de afspraak die deze vervangt (bij Calendly de Old Invitee). Dan blijft het dezelfde afspraak en dezelfde videolink. Leeg laten bij een nieuwe afspraak.
leadslijst van objecten
Tot 100 leads in één verzoek.
Velden tonen
- telefoonstringverplicht
  Verplicht. Een Nederlands nummer mag met voorloopnul (0612345678); een buitenlands nummer met landnummer (+32470123456). Hierop herkennen we een lead terug in de campagne.
- voornaamstring
- achternaamstring
- bedrijfstring
- functiestring
- emailstring
  Nodig voor de bevestiging als je een afspraak meestuurt.
- externe_idstring
  Jouw eigen id van deze lead. Komt terug in het antwoord.
- warmtestring
  Standaard koud; een lead die wordt heropend, wordt warm.
  Een van: koud, warm, heet
- notitiestring
  Komt als eerste notitie op de lead te staan.
- fasestring
  Waar een nieuwe lead begint; standaard nieuwe_leads. Met een afspraak erbij standaard binnengekomen (Afspraak ingepland). Een bestaande lead houdt zijn fase.
  Een van: nieuwe_leads, gebeld_1, gebeld_2, gebeld_3, gebeld_4, niet_bereikt, follow_up, follow_up_lang, binnengekomen
- afspraakobject
  Een afspraak die de lead zelf boekte, bijvoorbeeld via Calendly. Aicquisition maakt de videoruimte, zet de lead op Afspraak ingepland bij de closer en mailt de bevestiging met de deelnamelink.
  Velden tonen
  - idstringverplicht
    Verplicht. Jouw id van deze afspraak; bij Calendly de Invitee URI. Hetzelfde bericht nog eens geeft geen tweede afspraak.
  - startstring
    Verplicht bij een nieuwe of verzette afspraak. Begin met tijdzone.
  - duur_minuteninteger
    Standaard 30.
  - closer_emailstring
    Verplicht bij een nieuwe of verzette afspraak. Het e-mailadres waarmee de closer in Aicquisition inlogt; opzoeken met Team opvragen.
  - statusstring
    "geannuleerd" zegt de afspraak met deze id af; er wordt dan geen lead aangemaakt. Standaard gepland.
    Een van: gepland, geannuleerd
  - vervangt_idstring
    Bij een verzetting: de id van de afspraak die deze vervangt (bij Calendly de Old Invitee). Dan blijft het dezelfde afspraak en dezelfde videolink. Leeg laten bij een nieuwe afspraak.

Antwoord

200Verwerkt, maar niets nieuws: de leads bestonden al.

okboolean
test_modusboolean
Waar bij een testsleutel: er is niets weggeschreven.
organisatie_idstring · uuid
campagne_idstring · uuid
lijst_idstring · uuid of null
aangemaaktinteger
heropendinteger
bestond_alinteger
geweigerdinteger
wacht_op_akkoordinteger
leadslijst van objecten
Per lead, in de volgorde van het verzoek.
Velden tonen
- externe_idstring
- telefoonstringverplicht
  Zoals opgeslagen, met landnummer.
- resultaatstring
  Een van: aangemaakt, heropend, bestond_al, geweigerd
- lead_idstring · uuid
- redenstring
- factornumber
  Belminuten per gebelde minuut naar dit nummer.
- wacht_op_akkoordboolean
  Wacht de lead op akkoord voor een hoger tarief?
- tarief_vastgesteldboolean
  Is het tarief al nagevraagd? Zo niet, dan wordt er nog niet gebeld.
- afspraakobject
  Velden tonen
  - resultaatstringverplicht
    test: testsleutel; reden zegt wat er echt zou gebeuren.
    Een van: gepland, al_gepland, verzet, geannuleerd, niet_gevonden, geweigerd, test
  - afspraak_idstring · uuid
  - redenstring
  - bevestiging_verstuurdboolean

201Er is minstens één lead aangemaakt of heropend, of een afspraak gepland. Een testsleutel geeft hetzelfde antwoord als een echte, met `test_modus: true`; er is dan niets weggeschreven.

okboolean
test_modusboolean
Waar bij een testsleutel: er is niets weggeschreven.
organisatie_idstring · uuid
campagne_idstring · uuid
lijst_idstring · uuid of null
aangemaaktinteger
heropendinteger
bestond_alinteger
geweigerdinteger
wacht_op_akkoordinteger
leadslijst van objecten
Per lead, in de volgorde van het verzoek.
Velden tonen
- externe_idstring
- telefoonstringverplicht
  Zoals opgeslagen, met landnummer.
- resultaatstring
  Een van: aangemaakt, heropend, bestond_al, geweigerd
- lead_idstring · uuid
- redenstring
- factornumber
  Belminuten per gebelde minuut naar dit nummer.
- wacht_op_akkoordboolean
  Wacht de lead op akkoord voor een hoger tarief?
- tarief_vastgesteldboolean
  Is het tarief al nagevraagd? Zo niet, dan wordt er nog niet gebeld.
- afspraakobject
  Velden tonen
  - resultaatstringverplicht
    test: testsleutel; reden zegt wat er echt zou gebeuren.
    Een van: gepland, al_gepland, verzet, geannuleerd, niet_gevonden, geweigerd, test
  - afspraak_idstring · uuid
  - redenstring
  - bevestiging_verstuurdboolean

Foutmeldingen

400Een afspraak heeft een "closer_email" nodig: het e-mailadres waarmee de closer in Aicquisition inlogt.
401Deze sleutel werkt niet.
403Deze sleutel hoort niet bij die organisatie.
404Onbekende campagne voor deze sleutel.
429Te veel verzoeken. Probeer het over een minuut opnieuw.