Hai dei dubbi o delle domande ? Non esitare a contattarci, inviandoci una email a support@brainlead.it
Invia una chiamata GET a questo indirizzo per ricercare le PERSONE in archivio.
La lista delle persone verrà ordinata prima per cognome e poi per nome della persona.
| Parametro | Tipo | Descrizione |
|---|---|---|
page |
integer | Pagina dei risultati che si vuole visualizzare. Per ogni pagina vengono restituiti un massimo di 30 records. |
query |
string | Testo di ricerca. Per ogni parte del testo, verrà ricercata l'eventuale corrispondenza nei campi: nome, cognome ed email della scheda persona. |
emails |
string | Emails. Per ogni email inserita, verrà ricercata l'eventuale presenza nella scheda persona. Nel caso si vogliano ricercare più email, queste devono essere separate dal carattere ",". La ricerca di più email verrà effettuata applicando la logica OR. |
phones |
string | Telefoni. Per ogni telefono inserito, verrà ricercata l'eventuale presenza nella scheda persona. Nel caso si vogliano ricercare più telefoni, questi devono essere separati dal carattere ",". La ricerca di più telefoni verrà effettuata applicando la logica OR. |
La chiamata restituirà un array con le persone che sono state trovate utilizzando i parametri impostati nella chiamata.
Per ogni persona verrà fornito un tracciato con le seguenti informazioni:
| Parametro | Tipo | Descrizione |
|---|---|---|
id |
integer | Id della persona. |
name |
string | Nome della persona (lunghezza 0-100). |
surname |
string | Cognome della persona (lunghezza 0-100). |
negotiation_status_id |
integer | Id stato trattativa della persona. |
company_id |
integer | Id società associata alla persona. Il valore 0 indica che la persona non è associata a nessuna società. |
score |
integer | Score della persona (valori da 0 a 100). |
grade |
string | Grade della persona (valori da F ad A+) |
emailemail_workemail_private |
Email associata alla persona (lunghezza 0-100).
Il parametro indica la tipologia di email associata alla persona:
|
|
phonephone_workphone_homephone_mobilefaxfax_homefax_work |
string |
Telefono associato alla persona (lunghezza 0-50).
Il parametro indica la tipologia di telefono associata alla persona:
|
addressaddress_primaryaddress_alternativeaddress_workaddress_homeaddress_billingaddress_shipping |
string |
Via dell'indirizzo associato alla persona (lunghezza 0-255).
Il parametro indica la tipologia di via associata alla persona:
|
citycity_primarycity_alternativecity_workcity_homecity_billingcity_shipping |
string |
Città dell'indirizzo associato alla persona (lunghezza 0-100).
Il parametro indica la tipologia di città associata alla persona:
|
provinceprovince_primaryprovince_alternativeprovince_workprovince_homeprovince_billingprovince_shipping |
string |
Provincia dell'indirizzo associato alla persona (lunghezza 0-45).
Il parametro indica la tipologia di provincia associata alla persona:
|
zipcodezipcode_primaryzipcode_alternativezipcode_workzipcode_homezipcode_billingzipcode_shipping |
string |
CAP dell'indirizzo associato alla persona (lunghezza 0-5).
Il parametro indica la tipologia di CAP associata alla persona:
|
regionregion_primaryregion_alternativeregion_workregion_homeregion_billingregion_shipping |
string |
Regione dell'indirizzo associato alla persona (lunghezza 0-45).
Il parametro indica la tipologia di regione associata alla persona:
|
countrycountry_primarycountry_alternativecountry_workcountry_homecountry_billingcountry_shipping |
string |
Nazione dell'indirizzo associato alla persona (lunghezza 0-45).
Il parametro indica la tipologia di nazione associata alla persona:
|
tags |
array | Tags associati alla persona. |
external_id |
string | Id sorgente esterna a cui associare la persona. Se il parametro contiene una stringa vuota, vuol dire che la persona al momento non ha nessun Id sorgente esterna associato. |
Invia una chiamata POST a questo indirizzo per creare una nuova PERSONA.
| Parametro | Tipo | Descrizione |
|---|---|---|
name |
string | Nome della persona (lunghezza 0-100). |
surname |
string | Cognome della persona (lunghezza 0-100). |
negotiation_status_id |
integer | Id stato trattativa della persona. Opzionale, default 0. |
company_id |
integer | Id società associata alla persona. Il valore 0 indica che la persona non è associata a nessuna società. |
emailemail_workemail_private |
email (Obbligatorio) |
Email associata alla persona (lunghezza 0-100).
Per indicare la tipologia dell'email, utilizzare il parametro associato:
Sono consentite più tipologie di email associate alla stessa persona. |
phonephone_workphone_homephone_mobilefaxfax_homefax_work |
string |
Telefono associato alla persona (lunghezza 0-50).
Per indicare la tipologia del telefono, utilizzare il parametro associato:
|
addressaddress_primaryaddress_alternativeaddress_workaddress_homeaddress_billingaddress_shipping |
string |
Via dell'indirizzo associato alla persona (lunghezza 0-255).
Per indicare la tipologia di via, utilizzare il parametro associato:
Sono consentite più tipologie di via associate alla stessa persona. |
citycity_primarycity_alternativecity_workcity_homecity_billingcity_shipping |
string |
Città dell'indirizzo associato alla persona (lunghezza 0-100).
Per indicare la tipologia di città, utilizzare il parametro associato:
Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di città associate alla stessa persona. |
provinceprovince_primaryprovince_alternativeprovince_workprovince_homeprovince_billingprovince_shipping |
string |
Provincia dell'indirizzo associato alla persona (lunghezza 0-45).
Nel campo va indicata la sigla della provincia, es: MI. Per indicare la tipologia di provincia, utilizzare il parametro associato:
Sono consentite più tipologie di provincia associate alla stessa persona. |
zipcodezipcode_primaryzipcode_alternativezipcode_workzipcode_homezipcode_billingzipcode_shipping |
string |
CAP dell'indirizzo associato alla persona (lunghezza 0-5).
Per indicare la tipologia di CAP, utilizzare il parametro associato:
Sono consentite più tipologie di CAP associate alla stessa persona. |
regionregion_primaryregion_alternativeregion_workregion_homeregion_billingregion_shipping |
string |
Regione dell'indirizzo associato alla persona (lunghezza 0-45).
Per indicare la tipologia di regione, utilizzare il parametro associato:
Sono consentite più tipologie di regione associate alla stessa persona. |
countrycountry_primarycountry_alternativecountry_workcountry_homecountry_billingcountry_shipping |
string |
Nazione dell'indirizzo associato alla persona (lunghezza 0-45).
Per indicare la tipologia di nazione, utilizzare il parametro associato:
Sono consentite più tipologie di nazione associate alla stessa persona. |
custom_field_ID |
string boolean numeric date enum money |
sostituisci ID con l'ID campo custom, es: custom_field_123. |
tags |
array |
Lista dei tags da assegnare alla persona.
La lista dovrà contenere gli ID dei tags da assegnare alla persona, che potranno essere ottenuti usando le api dedicate ai tags. |
external_id |
string | Id sorgente esterna a cui associare la persona. |
| Parametro | Tipo | Descrizione |
|---|---|---|
id |
integer | Id della nuova persona. |
Invia una chiamata GET a questo indirizzo per visualizzare la scheda della PERSONA.
Nella chiamata sostituire {:id} con l'id persona da consultare.
| Parametro | Tipo | Descrizione |
|---|---|---|
name |
string | Nome della persona. |
surname |
string | Cognome della persona. |
negotiation_status_id |
integer | Id stato trattativa della persona. |
company_id |
integer | Id società associata alla persona. Il valore 0 indica che la persona non è associata a nessuna società. |
company |
string | società associata alla persona. |
emailemail_workemail_private |
Email associata alla persona.
Le tipologie dell'email, gestite dalla piattaforma, sono:
Sono consentite più tipologie di email associate alla stessa persona. |
|
email_statusemail_work_statusemail_private_status |
string |
Stato associato alla email della persona.
Per ogni tipologia di email presente, sarà evidenziato il suo stato. I possibili valori di stato sono:
|
phonephone_workphone_homephone_mobilefaxfax_homefax_work |
string |
Telefono associato alla persona.
Le tipologie di telefono, gestite dalla piattaforma, sono:
|
addressaddress_primaryaddress_alternativeaddress_workaddress_homeaddress_billingaddress_shipping |
string |
Via dell'indirizzo associato alla persona.
Le tipologie di via, gestite dalla piattaforma, sono:
Sono consentite più tipologie di via associate alla stessa persona. |
citycity_primarycity_alternativecity_workcity_homecity_billingcity_shipping |
string |
Città dell'indirizzo associato alla persona.
Le tipologie di città, gestite dalla piattaforma, sono:
Sono consentite più tipologie di città associate alla stessa persona. |
provinceprovince_primaryprovince_alternativeprovince_workprovince_homeprovince_billingprovince_shipping |
string |
Provincia dell'indirizzo associato alla persona.
Le tipologie di provincia, gestite dalla piattaforma, sono:
Sono consentite più tipologie di provincia associate alla stessa persona. |
zipcodezipcode_primaryzipcode_alternativezipcode_workzipcode_homezipcode_billingzipcode_shipping |
string |
CAP dell'indirizzo associato alla persona.
Le tipologie di CAP, gestite dalla piattaforma, sono:
Sono consentite più tipologie di CAP associate alla stessa persona. |
regionregion_primaryregion_alternativeregion_workregion_homeregion_billingregion_shipping |
string |
Regione dell'indirizzo associato alla persona (lunghezza 0-45).
Le tipologie di regione, gestite dalla piattaforma, sono:
Sono consentite più tipologie di regione associate alla stessa persona. |
countrycountry_primarycountry_alternativecountry_workcountry_homecountry_billingcountry_shipping |
string |
Nazione dell'indirizzo associato alla persona (lunghezza 0-45).
Le tipologie di nazione, gestite dalla piattaforma, sono:
Sono consentite più tipologie di nazione associate alla stessa persona. |
custom_field_ID |
string boolean numeric date enum money |
|
tags |
array | Tags associati alla persona. |
Invia una chiamata POST a questo indirizzo per modificare una PERSONA.
Nella chiamata sostituire {:id} con l'id persona da modificare.
| Parametro | Tipo | Descrizione |
|---|---|---|
name |
string | Nome della persona (lunghezza 0-100). |
surname |
string | Cognome della persona (lunghezza 0-100). |
negotiation_status_id |
integer | Id stato trattativa della persona. Opzionale, default 0. |
company_id |
integer | Id società associata alla persona. Il valore 0 indica che la persona non è associata a nessuna società. |
emailemail_workemail_private |
Email associata alla persona (lunghezza 0-100).
Per indicare la tipologia dell'email, utilizzare il parametro associato:
Sono consentite più tipologie di email associate alla stessa persona. |
|
subscribe_emails |
boolean | Per indicare se riattivare (rimuovere dallo stato di unsubscribe) le emails collegate alla persona. |
phonephone_workphone_homephone_mobilefaxfax_homefax_work |
string |
Telefono associato alla persona (lunghezza 0-50).
Per indicare la tipologia del telefono, utilizzare il parametro associato:
|
addressaddress_primaryaddress_alternativeaddress_workaddress_homeaddress_billingaddress_shipping |
string |
Via dell'indirizzo associato alla persona (lunghezza 0-255).
Per indicare la tipologia di via, utilizzare il parametro associato:
Sono consentite più tipologie di via associate alla stessa persona. |
citycity_primarycity_alternativecity_workcity_homecity_billingcity_shipping |
string |
Città dell'indirizzo associato alla persona (lunghezza 0-100).
Per indicare la tipologia di città, utilizzare il parametro associato:
Nel caso in cui si voglia inserire un indirizzo con indicata la via, il campo città della stessa tipologia, diventa obbligatorio. Sono consentite più tipologie di città associate alla stessa persona. |
provinceprovince_primaryprovince_alternativeprovince_workprovince_homeprovince_billingprovince_shipping |
string |
Provincia dell'indirizzo associato alla persona (lunghezza 0-45).
Nel campo va indicata la sigla della provincia, es: MI. Per indicare la tipologia di provincia, utilizzare il parametro associato:
Sono consentite più tipologie di provincia associate alla stessa persona. |
zipcodezipcode_primaryzipcode_alternativezipcode_workzipcode_homezipcode_billingzipcode_shipping |
string |
CAP dell'indirizzo associato alla persona (lunghezza 0-5).
Per indicare la tipologia di CAP, utilizzare il parametro associato:
Sono consentite più tipologie di CAP associate alla stessa persona. |
regionregion_primaryregion_alternativeregion_workregion_homeregion_billingregion_shipping |
string |
Regione dell'indirizzo associato alla persona (lunghezza 0-5).
Per indicare la tipologia di regione, utilizzare il parametro associato:
Sono consentite più tipologie di regione associate alla stessa persona. |
countrycountry_primarycountry_alternativecountry_workcountry_homecountry_billingcountry_shipping |
string |
Nazione dell'indirizzo associato alla persona (lunghezza 0-5).
Per indicare la tipologia di nazione, utilizzare il parametro associato:
Sono consentite più tipologie di nazione associate alla stessa persona. |
custom_field_ID |
string boolean numeric date enum money |
sostituisci ID con l'ID campo custom, es: custom_field_123. |
tags |
array |
Lista dei tags da assegnare o rimuovere dalla persona.
La lista dovrà contenere gli ID dei tags da assegnare alla persona, che potranno essere ottenuti usando le api dedicate ai tags. Se si desidera rimuovere un tag dalla persona, il suo ID dovrà essere preceduto dal carattere -, es: -1234.
|
external_id |
string | Id sorgente esterna a cui associare la persona. |
| Parametro | Tipo | Descrizione |
|---|---|---|
updated |
boolean | Contiene true se la chiamata ha prodotto un aggiornamento della scheda della persona, altrimenti sarà false. |
Invia una chiamata GET a questo indirizzo per ottenere la timeline con i comportamenti tracciati sulla PERSONA.
Nella chiamata sostituire {:id} con l'id persona da analizzare.
| Parametro | Tipo | Descrizione |
|---|---|---|
timeline |
array |
Contiene l'elenco dei comportamenti della persona, ordinati per data. Per ogni comportamento il campo type, indica il tipo di comportamento tracciato. Il comportamento action, indica che è presente un azione in agenda. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_sent, indica che è stata inviata una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_opening, indica che è stata aperta una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_click, indica che è stata cliccata una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_reply, indica che è stato risposto ad una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_bounce_soft, indica che è stato rilevato un bounce soft su una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_bounce_hard, indica che è stato rilevato un bounce hard su una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_email_unsubscription, indica che è stata rilevata una disiscrizione su una campagna email. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_sms_sent, indica che è stata inviata una campagna sms. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento campaign_exit, indica che è uscito da una campagna. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento carts, indica che è stato generato un carrello. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento courses_purchased, indica che è stato acquistato un corso. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento courses_frequented, indica che è stata frequentata una edizione di un corso. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento updated, indica che è stata aggiornata la scheda anagrafica. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento web_form_subscription, indica che è stato compilato un web form. A corredo del comportamento, vengono fornite le seguenti informazioni:
Il comportamento web_visit, indica che è stata vista una pagina web. A corredo del comportamento, vengono fornite le seguenti informazioni:
|
Invia una chiamata DELETE a questo indirizzo per eliminare una PERSONA.
Nella chiamata sostituire {:id} con l'id persona da eliminare.
| Parametro | Tipo | Descrizione |
|---|---|---|
deleted |
boolean | Contiene true se l'eliminazione è andata a buon fine. |
Invia una chiamata POST a questo indirizzo per disiscrivere un indirizzo email collegato ad una persona.
| Parametro | Tipo | Descrizione |
|---|---|---|
email |
email (Obbligatorio) |
Email da disiscrivere (lunghezza 1-100). |
| Parametro | Tipo | Descrizione |
|---|---|---|
unsubscribed |
boolean | Contiene true se la chiamata ha prodotto una disiscrizione della persona, altrimenti sarà false. |
© 2010-2019 BrainLead