Come disiscrivere un contatto da una lista tramite API

Tempo di lettura: 5 minuti

Difficoltà: Avanzata

Vediamo come usare le API di 4Dem per disiscrivere un contatto presente in una lista della piattaforma.

In questa guida:

Creare un Api Key

Il primo passo è generare sulla tua tua console un Api Key per effettuare l'autenticazione.

Per creare o gestire un api key accedi dalla tua console alla sezione "Api Key" che trovi all'interno dell'icona "Strumenti", quindi fai click su "AGGIUNGI".

Limita un indirizzo IP

È possibile limitare l'accesso alla tua Api Key da uno specifico indirizzo IP inserendolo nell'apposito campo del popup di creazione dell' api key.

Autenticarsi su 4Dem

Generata un Api Key dovrai effettuare l'autenticazione su 4Dem.

Per effettuare la chiamata http puoi utilizzare i seguenti parametri:

Method:

POST

Url:

https://api.4dem.it/authenticate

Body:

{"APIKey":"la-tua-api-key"}

Esempio di risposta:

Per la documentazione completa puoi consultare: https://api.4dem.it/#!/Authentication/authenticate

Disiscrivere un contatto

Per effettuare la chiamata http puoi utilizzare i seguenti parametri:

Documentazione:

https://api.4dem.it/#!/Contacts/subscribers_unsubscribe

Method:

POST

Url:

https://api.4dem.it/recipients/{{id_lista}}/unsubscribe?token={{token}}

Body:

{
  "subscriber_id": 7,
  "email_address": "email@domain.dev",
  "mobile": "+393331111111",
  "ip":"0.0.0.0"
  “motivation”:”1”
}

E’ sempre consigliato aggiungere il campo “motivation” al body della richiesta con un valore numerico da 1 a 5. Il significato di ogni numero è il seguente:

1: Non sono più interessato a ricevere questo tipo di comunicazioni

2: I contenuti che ricevo non sono interessanti

3: Ricevo queste email troppo spesso

4: Non ricordo di essermi iscritto a questa mailing list

5: Penso che queste e-mail siano spam

Campi necessari

E’ possibile eliminare un contatto da una lista specificando il suo subscriber_id, il suo indirizzo email oppure il suo telefono. Non è necessario inserire tutti e tre i campi, ma è obbligatorio inserirne almeno uno dei tre.

Esempio di risposta:

L’indirizzo ip è obbligatorio inserirlo nella richiesta. Rappresenta l’ip del richiedente. Non è detto che sia l’indirizzo ip del contatto, ma può anche essere l’indirizzo ip del software che sta effettuando la chiamata API. Il dato serve per tracciare da dove viene la richiesta.

Riassumendo:

  • Genera l'api key dalla console.
  • Effettua l' autenticazione utilizzando i parametri forniti oppure consulta la documentazione completa.
  • E’ possibile eliminare un contatto da una lista specificando almeno dei seguenti dati: subscriber_id, indirizzo email oppure il telefono cellulare principale.