Leads
Leads in een lijst
https://aicquisitioncrm.nl/api/v2/lijsten/{id}/leadsRecht: lezen.
Nieuwste wijziging eerst. Met gewijzigd_sinds haal je alleen op wat er sinds je vorige keer veranderde: bewaar het gewijzigd van de eerste lead en geef het de volgende keer mee.
Verzoek
In het pad
idstring · uuidverplichtHet id van de lijst.
In de vraag
campagne_idstring · uuidAlleen deze campagne.
fasestringEén of meer fases, met komma's:
gebeld_1,gebeld_2. Zie GET /api/v2/fases.gewijzigd_sindsstring · date-timeAlleen leads die sinds dit moment veranderden.
zoekstringNaam, e-mail of telefoonnummer (06… mag); elk woord moet ergens voorkomen.
externe_idstringDe id die jullie zelf meegaven bij het aanleveren.
limietintegerstandaard 50Hoeveel per bladzijde, 1 tot 200.
cursorstringDe volgende_cursor uit het vorige antwoord.
Antwoord
200Een bladzijde leads.
datalijst van objectenVelden tonen
idstring · uuidcampagne_idstring · uuidlijst_idstring · uuid of nullfasestringEen van:
nieuwe_leads,gebeld_1,gebeld_2,gebeld_3,gebeld_4,niet_bereikt,follow_up,binnengekomen,pre_call,bevestigd,dag_van_de_call,gewonnen,follow_up_kort,follow_up_lang,verloren,cancel,no_show,reschedulefase_naamstringZoals hij in Aicquisition heet.
warmtestring of nullEen van:
koud,warm,heetcontactobjectVelden tonen
voornaamstring of nullachternaamstring of nulltelefoonstring of nullMet landnummer.
emailstring of nullfunctiestring of null
bedrijfobject of nullVelden tonen
naamstringplaatsstring of null
setterobject of nullVelden tonen
naamstring of nullemailstring of null
closerobject of nullVelden tonen
naamstring of nullemailstring of null
pogingenintegerHoe vaak er gebeld is.
laatste_pogingstring · date-time of nullvolgende_actiestring · date-time of nullWanneer de lead weer aan de beurt is.
volgende_actie_is_afspraakbooleanIs dat moment met de lead afgesproken?
waarde_centinteger of nullExclusief btw.
verloren_redenstring of nullupsellbooleanwacht_op_akkoordbooleanWacht op akkoord voor een hoger beltarief.
bronstring of nullexterne_idstring of nullaangemaaktstring · date-timegewijzigdstring · date-time
volgende_cursorstring of nullGeef mee als cursor voor de volgende bladzijde; null betekent klaar.
Foutmeldingen
- 400Het verzoek klopt niet; het antwoord noemt de fout en het veld.
- 401Geen sleutel, of een sleutel die niet (meer) werkt.
- 403De sleutel mist het recht Lezen.
- 429Meer dan 60 verzoeken per minuut; wacht een minuut.