System API

L‘API di sistema è progettato per integrare la tua applicazione con SqualoMail.

Principi di base

 

Operazioni disponibili

Tutte le funzioni richiedono sempre l’invio dei parametri api_user e api_key! Perciò in seguito questo non verrà più ripetuto. Le funzioni disponibili sono:

  1. create-list
  2. create-newsletter
  3. create-newsletter-from-template
  4. create-recipient
  5. delete-newsletter
  6. delete-recipient
  7. get-data
  8. get-invalid-recipients
  9. get-subscribed-recipients
  10. get-unsubscribed-recipients
  11. send-newsletterr
  12. update-newsletter
  13. update-recipient

 

1. create-list

Funzione di invio: POST

Con questa funzione puoi creare una nuova lista di destinatari. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • name – il nome della lista
  • description – la descrizione della lista
  • category – categoria della lista
  • color – il colore in hex della lista
  • ordering – il ordine della lista come viene visualizzata nel GUI – da 0 a 2147483647
  • published – la lista è pubblicata o no (boolean)

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"name":"String content",
	"description":"String content",
	"category":"String content",
	"color":"String content",
	"ordering":2147483647,
	"published":true,
}

 

2. create-newsletter

Funzione di invio: POST

Con questa funzione puoi creare una nuova newsletter e decidere su quale lista verrà inviata. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • subject – Oggetto (Subject) della newsletter
  • body – testo della newsletter
  • altBody – versione testuale del contenuto della newsletter
  • fromEmail – indirizzo email del mittente (facoltativo, altrimenti viene configurato quello predefinito)
  • fromName – nome del mittente, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToEmail – indirizzo email per la risposta (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToName – nome del mittente per la risposta, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • language – lingua della newsletter. Puoi scegliere tra DE, EN, ES, FR, HR, IT e SL (facoltativo, predefinito è lo SL (sloveno))
  • listIds – ID numeri delle liste, alle quali verrà inviata la newsletter (l’invio viene fatto dopo con un’altra funzione). L’esempio del formato è il seguente: [4,6]. L’ID della lista lo trovi tramite queste istruzioni.
  • published – data di pubblicazione (non dell’invio!). La data è nel formato UNIX Timestamp (facoltativo)
  • visible – se la newsletter è visibile ai destinatari (si possono iscrivere/disiscrivere da soli). I possibili valori sono true o false.

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"altBody":"String content",
	"body":"String content",
	"fromEmail":"String content",
	"fromName":"String content",
	"language":"String content",
	"listIds":[2147483647],
	"published":2147483647,
	"replyToEmail":"String content",
	"replyToName":"String content",
	"subject":"String content",
	"visible":true
}

 

3. create-newsletter-from-template

Metodo di invio: POST

Questa funzione ti permette di creare una nuova newsletter usando una già esistente. La bozza per il template può essere qualunque newsletter già esistente.

A disposizione hai i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • subject – Oggetto (Subject) della newsletter
  • fromEmail – indirizzo email del mittente (facoltativo, altrimenti viene configurato quello predefinito)
  • fromName – nome del mittente, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToEmail – indirizzo email per la risposta (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToName – nome del mittente per la risposta, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • language – lingua della newsletter. Puoi scegliere tra DE, EN, ES, FR, HR, IT e SL (facoltativo, predefinito è lo SL (sloveno))
  • listIds – ID numeri delle liste, alle quali verrà inviata la newsletter (l’invio viene fatto dopo con un’altra funzione). L’esempio del formato è il seguente: [4,6]. L’ID della lista lo trovi tramite queste istruzioni.
  • templateId – ID numero della newsletter già esistente, che verrà usata come base per la creazione delle nuova.
  • templateCustomAttributes – Attributi su misura, che vengono inseriti nel corpo (body) della newsletter già esistente ovvero nella bozza dalla quale viene creata la nuova newsletter.

 

TemplateCustomAtrributes

Questo insieme di parametri ti permette di preparare in anticipo la bozza nel sistema SqualoMail e di inserire una tag specifica (template tag), che con la chiamata di questa funzione verrà sostituita con un valore concreto.

Lo scenario, con il quale questa funzionalità può essere utilizzata, è quando desideri usare il Drag&Drop editore di SqualoMail per preparare la forma della newsletter e poi automatizzare l’inserimento del contenuto.

 

Il template tag viene segnato con delle doppie parentesi graffe – {{template_tag}}. Hai a disposizione due template tag basilari:

  1. texts – con il suo aiuto puoi inserire ad un determinata locazione un tuo testo desiderata o HTML.
  2. images – con il suo aiuto puoi sostituire le immagine selezionate nella bozza con le immagini desiderate della newsletter finale.

Texts

Definisci i testi come una tabella (array) di identificatori desiderati (p.es.: heading, subheading, ecc.) e valori, che verranno inseriti. I nomi degli identificatori sono a tua scelta – l’importante è solamente essere consistenti nella creazione della bozza di base e poi anche dalla chiamata di questa funzione.

Esempio:

Nel Drag&Drop editore inserisci il testo sottostante:

 

Dopo la chiamata con i parametri che seguono:

{

	"templateCustomAttributes":
	{"texts":
        [
            {
                "itemId":"column1-heading",
                "itemContent":
                {
                    "value":"NEW items for better zzzzzzs"
                }
            },
            {
                "itemId":"column1-subheading",
                "itemContent":
                {
                    "url":"http://www.google.com",
                    "value":"Everybody deserves a good night sleep :)"
                }
            },
			{
                "itemId":"column1-text",
                "itemContent":
                {
                    "value":"Fusce at tristique urna, sit amet elementum odio.	Nullam vulputate at felis ut eleifend. Pellentesque euismod libero diam, viverra placerat risus vestibulum non. Praesent at rutrum odio. Quisque vel suscipit sem."
                }
            }
        ]
    }
}

e riceverai:

Qui c’è da sottolineare che se desideri stilizzare i link, non è possibile farlo nel Drag&Drop editore, ma lo devi fare senza aggiungere il parametro “url”, quindi aggiungi solamente <a style=”…

Images

Con l’attributo template “images” puoi aggiungere nelle locazioni selezionate della bozza di base le immagini dall’URL.

“Seleziona” le immagini nel Drag&Drop editore, scegliendo l’immagine da /images/SqualoMail-templates/_placeholders/.

All’interno della cartella troverai delle sottocartelle segnate da 0 a 9. Questi numeri rappresentano il numero ID dell’immagine e ognuno di questi numeri rappresenta una immagine nella bozza. Questo significa, che devi per ogni locazione selezionata scegliere l’immagine dall’altra sottocartella.

In ogni sottocartella hai a disposizione più dimensioni di immagini, che si differenziano a seconda della proporzione dei lati (aspect ratio). Devi scegliere l’immagine, che ha per te la corretta proporzione dei lati, dopodiché come fatto abitualmente, adegua le sue dimensioni con il cursore del Drag&Drop editore.

Le dimensioni dell’immagine che inserirai non è così importate, infatti le dimensioni verranno adeguate a quello che hai impostato con il cursore. Più importate è l’inserimento dell’immagine con la giusta proporzione dei lati, altrimenti saranno allungate.

All’immagine puoi anche aggiungere un link con il parametro “url”.

 

Esempio:

1. Bozza

2. La chiamata della funzione ha i seguenti parametri:

"templateCustomAttributes":
{
    "images":
    {
        [
            {
                "itemId":"0",
                "itemContent":
                {
                    "url":"https://www.google.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-1-5x4.png"
                }
            },
            {
                "itemId":"1",
                "itemContent":
                {
                    "url":"https://www.yahoo.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-2-5x4.png"
                }
            },
            {
                "itemId":"2",
                "itemContent":
                {
                    "url":"https://www.apple.com",
                    "value":"https://11.squalomail.net/images/image-3-column-placement-3-5x4.png"
                }
            }
        ]
    }
}

3. Risultato:

 

Un esempio di tutte le possibilità che offre la funzione

"apiKey":"String content",
"apiUser":"String content",
"fromEmail":"String content",
"fromName":"String content",
"language":"String content",
"listIds":[2147483647],
"published":true,
"replyToEmail":"String content",
"replyToName":"String content",
"subject":"String content",
"visible":true,
"templateId":2147483647,
"templateCustomAttributes":
{
    "images":
    [
        {
            "itemId":"String content", "itemContent":
            {
                "url":"String content",
                "value":"String content"
            }
        }
    ],
    "texts":
    [
        {
            "itemId":"String content",
            "itemContent":
            {
                "url":"String content",
                "value":"String content"
            }
        }
    ]
}

 

4. create-recipient

Metodo di invio: POST

Con questa funzione crei un nuovo destinatario e allo stesso tempo lo aggiungi su nessuna o più liste. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • email – indirizzo email del destinatario
  • name – nome del destinatario
  • listIds – ID numeri delle liste, alle quali il destinatario sarà iscritto. L’esempio del formato è il seguente: [4,6]. L’ID della lista lo trovi tramite queste istruzioni.
  • html – se il destinatario accetta i messaggi in formato HTML oppure solo in quello testuale.
  • confirmed – se il destinatario consente di accettare i messaggi (i messaggi saranno comunque inviati).
  • enabled – se il destinatario è abilitato (i destinatari non abilitati non esistono)
  • accept – se il destinatario accetta i messaggi
  • customAttributes – lista delle coppie di chiavi, valori (key, value) per i campi personalizzati del destinatario su misura. Per il nome del campo usa lo spazio »NOME DEL CAMPO PERSONALIZZATO«, che è disponibile tramite l’interfaccia utente grafica.

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"accept":true,
	"confirmed":true,
	"customAttributes":[
		{
		"name":"firstname",
		"value":"John"
		},
		{
		"name":"lastname",
		"value":"Smith"
		}
	],
	"email":"String content",
	"enabled":true,
	"html":true,
	"listIds":[2147483647],
	"name":"String content"
}

 

5. delete-newsletter

Funzione di invio: GET

Con questa funzione puoi cancellare la newsletter. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • newsletterId – ID numero della newsletter, che desideri cancellare

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"newsletterId":2147483647,
}

 

6. delete-recipient

Funzione di invio: GET

Con questa funzione puoi cancellare il destinatario. La funzione accetta solo un parametro:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • recipientId – ID numero del destinatario, che desideri cancellare

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"recipientId":2147483647,
}

 

7. get-data

Funzione di invio: GET oppure POST

Con questa funzione puoi ottenere tutti i dati, che sono disponibili nel sistema SqualoMail. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • entity – segna l’entità, che definirà il tipo di elemento, che desideri ottenere. Hai a disposizione le entità Field, History, List, ListMail, ListSub, Mail, Recipient, Stats, Url, UrlClick, UserStats. Le informazioni dettagliate le trovi di sotto.
  • filter – con questo parametro definisci quali entità (a seconda dei campi personalizzati), desideri ottenere.

Esempio:

http://api.squalomail.com/get-data?apiUser={APIUSER}&apiKey={APIKEY}&entity=Subscriber&filter=email.Endswith(%22gmail.com%22)

 

In seguito presenteremo le entità che sono disponibili, quali campi personalizzati hanno e quali filtri puoi usare.

 

ENTITÀ E CAMPI PERSONALIZZATI

Qui sono elencate tutte le entità e i loro campi personalizzati, che vengono usati quando costruisci un filtro per la funzione get-data.

Field

Questa entità rappresenta i campi personalizzati di destinatario su misura di SqualoMail (come sono nominati in GUI). Questa entità supporta i seguenti campi personalizzati:

  • fieldid – ID numero del campo personalizzato su misura
  • fieldname – tag del campo personalizzato (un bel nome per gli utenti)
  • namekey – nome del campo personalizzato (sistematico, senza spazi)
  • type – il tipo può essere text, checkbox, radio o textarea
  • value – valore predefinito del campo personalizzato su misura
  • published – se il campo personalizzato è disponibile per l’uso.
  • ordering – l’ordine in confronto agli altri – numero naturale

History

Le entità di questo tipo sono gli eventi, che hanno fatto i destinatari nel sistema SqualoMail. Per esempio abbiamo i click sui collegamenti, le email aperte, la cancellazione, l’aggiunta alla lista ecc. I parametri disponibili sono:

  • subid – ID numero del destinatario
  • date – data, quando è avvenuto l’evento nel fromato UNIX Timestamp
  • action – l’azione, che è avvenuta

List

L’entità list rappresenta la Lista. Disponibili sono i seguenti campi personalizzati:

  • listid – ID numero della lista
  • name – nome della lista
  • category – nome della categoria della lista
  • color – il colore in GUI
  • visible – se la lista è visibile ai destinatari.
  • alias – il valore del parametro Google analytics utm_campaign

Mail

Questa entità rappresenta la newsletter. Disponibili sono i seguenti campi personalizzati:

  • mailid – ID numero della newsletter
  • subject – oggetto (subject) della newsletter
  • body – contenuto della newsletter
  • altbody – versione testuale del contenuto
  • published – “0” significa, che non è pubblicato, “1”, che è pubblicato (visibile ai destinatari), “2”, che è in lista d’attesa per l’invio
  • senddate – data di invio nel formato UNIX Timestamp
  • created – data, quando è stata creata la newsletter nel formato UNIX Timestamp
  • fromemail – indirizzo email del mittente. Se è vuoto verrà usato quello predefinito.
  • fromname – nome del mittente. Se è vuoto verrà usato quello predefinito.
  • replytoemail – indirizzo email per la risposta. Se è vuoto verrà usato quello predefinito.
  • replytoname – nome per la risposta, visibile al destinatario. Se è vuoto verrà usato quello predefinito.
  • language – lingua della newsletter; può essere uno tra de, en, es, fr, hr, it oppure sl.

Recipient

Questa entità rappresenta il destinatario. Questa funzione permette la ricerca tramite i campi personalizzati del destinatario su misura. Disponibili sono i seguenti campi personalizzati:

  • subid – ID numero del destinatario
  • email – indirizzo email del destinatario
  • name – nome del destinatario
  • enabled – se il destinatario è abilitato (se probabilmente non esiste)
  • ip – indirizzo IP del destinatario
  • html – se il destinatario accetta i messaggi in formato HTML
  • accept – se il destinatario accetta i messaggi (non ha cancellato l’iscrizione)
  • created – data, quando è stato creato il destinatario nel formato UNIX Timestamp
  • confirmed – se il destinatario ha confermato l’iscrizione
  • confirmed_date – data, quando il destinatario ha confermato l’iscrizione nel formato UNIX Timestamp
  • lastopen_date – data, quando il destinatario ha aperto l’ultima volta qualche newsletter nel formato UNIX Timestamp
  • lastclick_date – data, quando il destinatario ha cliccato l’ultima volta su qualche link nella newsletter nel formato UNIX Timestamp
  • lastsent_date – data, quando è stata inviata qualche newsletter nel formato UNIX Timestamp.

ListMail

Entità di collegamento tra le entità List e Mail per la realizzazione del rapporto many-to-many. Disponibili sono i seguenti campi personalizzati:

  • listid – ID numero della lista
  • mailid – ID numero della newsletter

ListSub

Entità di collegamento tra le entità List e Recipient per la realizzazione del rapporto many-to-many. Disponibili sono i seguenti campi personalizzati:

  • listid – ID numero della lista
  • subid – ID numero del destinatario
  • subdate – data, quando il destinatario si è iscritto alla lista nel formato UNIX Timestamp
  • unsubdate – data, quando il destinatario ha cancellato l’iscrizione dalla lista nel formato UNIX Timestamp
  • status – “1” significa iscritto, “-1” significa disiscritto

Stats

L’entità Stats rappresenta la statistica della newsletter individuale. I campi personalizzati disponibili sono:

  • mailid – ID numero di newsletter
  • senthtml – numero di messaggi inviati nel formato HTML
  • senttext – numero di messaggi inviati nel formato testuale
  • senddate – data di invio nel formato UNIX Timestamp
  • openunique – numero di aperture mail univoche (se un destinatario ha aperto un messaggio più volte, questa azione verrà annotata solo una volta)
  • opentotal – numero di messaggi aperti (se il destinatario ha aperto lo stesso messaggio più volte, questa azione verrà annotata più volte)
  • cliclunique – numero dei click unici (se un destinatario ha cliccato su uno stesso link più volte, questa azione verrà annotata solo una volta)
  • clicktotal – numero di tutti i click (se il destinatario ha cliccato su uno stesso link più volte, l’azione verrà anche annotata più volte)
  • bounceunique – numero di rimbalzi (hard + soft bounces)
  • fail – numero di messaggi non consegnati
  • unsub – numero di cancellazioni di iscrizione
  • forward – numero di messaggi inoltrati

UserStats

Questa entità rappresenta i dati statistici di ogni utente a seconda della newsletter. Disponibili sono i seguenti campi personalizzati:

  • subid – ID numero del destinatario
  • mailid – ID numero della newsletter
  • open – se il destinatario ha aperto la newsletter
  • opendate – quando il destinatario ha aperto la newsletter
  • bounce – se il messaggio è stato respinto
  • fail – se l’invio del messaggio non è riuscito
  • browser – quale browser usa il destinatario (a disposizione solamente se il destinatario ha aperto il messaggio con: firefox, chorme, msie, …)
  • browser_version – la versione del browser (a disposizione solamente se il destinatario ha aperto il messaggio)
  • is_mobile – se il destinatario ha aperto il messaggio con un dispositivo mobile
  • mobile_os – con quale sistema operativo il destinatario ha aperto il messaggio
  • user_agent – informazioni sul browser del destinatario

UrlClick

Questa entità rappresenta il click del destinatario su un link. Ogni link ha un suo numero ID, dove il suo valore è salvato come un’entità URL (descrizione di sotto). I campi personalizzati disponibili sono:

  • mailid – ID numero della newsletter
  • subid – ID numero del destinatario
  • urlid – ID numero del link
  • click – numero dei click del destinatario su un link
  • date – data, quando è avvenuto l’ultimo klick
  • ip – indirizzo IP da dove è avvenuto l’ultimo klick

Url

Questa entità rappresenta il collegamento nella newsletter. Ogni collegamento in ogni newsletter è un’entità separata, anche se il fine del collegamento è lo stesso. Disponibili sono i seguenti campi personalizzati:

  • urlid – ID numero del link
  • name – nome del link
  • url – il fine del link

 

FILTRI

I filtri vengono creati all’interno del parametro filter.

Record

Il filtro viene creato iscrivendo il nome, l’operation ed il valore. Per i string, i valori devono essere annotati con le virgolette, mentre i numeri no.

Esempio:

email=="test@gmail.com"
created>1451606400

Operations

Confronto

  • == – confronto, se il valore corrisponde esattamente
  • >=
  • <=
  • >
  • <
  • !=

Operations logici

I filtri sono costituiti dalle condizoni, che si possono collegare tra loro con uno degli operation:

  • && – logico E
  • || – logico O

Esempio:

created>1451606400&&created<1454284800

Funzioni

Per i campi personalizzati, che sono di tipo string, hai a disposizione più funzioni:

  • Startwith(“str”) – il valore inizia con str
  • Endswith(“str”) – il valore termina con str

Nota: La funzione not equals può essere fatta con la negazione di Equals.

Esempio:

email.Endswith("gmail.com")


Negazione

Puoi negare il filtro con l’uso dell’operation ! (prima del nome del campo personalizzato).

Esempio:

!email.Endswith('gmail.com')

Esempio dell’intero request

Il filtro deve essere sempre codificato in URL.

Esempio:

https://api.squalomail.com/v1/get-data?apiUser=[api_user]&apiKey=[api_key]&entity=recipient&filter=created%3E1451606400%26%26created%3C1454284800

 

Note

La funzione get-data non permette il filtraggio dei campi personalizzati del destinatario fatti su misura.

 

8. get-invalid-recipients

Funzione di invio: GET

Con questa funzione ottieni tutti i destinatari che non sono abilitati. Di solito, la ragione è un indirizzo email non valido o non attivo. Questa funzione non ha nessun parametro speciale, tranne l’autenticazione:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
}

 

9. get-subscribed-recipients

Funzione di invio: GET

Questa funzione restituisce tutti i destinatari, che sono iscritti ad una lista. Questo non vale per i destinatari non iscritti, comprende però quelli non abilitati (enabled=0). Disponibili sono i seguenti campi personalizzati:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • listId – ID numero della lista, per la quale desideri ottenere i destinatari iscritti.

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listId":"2147483647"
}

 

10. get-unsubscribed-recipients

Funzione di invio: GET

Questa funzione restituisce tutti i destinatari, che hanno cancellato l’iscrizione da un lista. Questi destinatari sono quelli che hanno cancellato l’iscrizione, e non quelli che non erano mai iscritti ad una lista. Il risultato comprende anche i destinatari non abilitati (enabled=0). Il parametro disponibile è solo uno:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • listId – ID numero della lista, per la quale desideri ottenere i destinatari iscritti

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"listId":"2147483647"
}

 

11. send-newsletter

Funzione di invio: GET

Impostazione di invio di una newsletter ad un determinato tempo. A quali liste verrà inviata, lo puoi impostare durante la creazione della newsletter (create-newsletter) o con la funzione update-newsletter. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • newsletterId – ID numero della newsletter, che desideri inviare
  • sendDate – data dell’invio nel formato UNIX Timestamp

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"newsletterId":2147483647,
	"sendDate":2147483647,
 }

 

12. update-newsletter

Funzione di invio: POST

Con questa funzione puoi sostituire i campi personalizzati di una newsletter. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • id – ID numero della newsletter, alla quale desideri sostituire i campi personalizzati
  • subject – oggetto (Subject) della newsletter
  • body – testo della newsletter
  • altBody – versione testuale del contenuto della newsletter
  • fromEmail – indirizzo email del mittente (facoltativo, altrimenti viene configurato quello predefinito)
  • fromName – nome del mittente, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToEmail – indirizzo email per la risposta (facoltativo, altrimenti viene configurato quello predefinito)
  • replyToName – nome del mittente per la risposta, come lo vede il destinatario (facoltativo, altrimenti viene configurato quello predefinito)
  • language – lingua della newsletter. Puoi scegliere tra DE, EN, ES, FR, HR, IT e SL (facoltativo, predefinito è lo SL (sloveno))
  • listIds – ID numeri delle liste, alle quali verrà inviata la newsletter (l’invio viene fatto dopo con un’altra funzione). L’esempio del formato è il seguente: [4,6]. L’ID della lista lo trovi tramite queste istruzioni.
  • published – data di pubblicazione (non dell’invio!). La data è nel formato UNIX Timestamp (facoltativo)
  • visible – se la newsletter è visibile ai destinatari (si possono iscrivere/disiscrivere da soli). I possibili valori sono true o false.

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"id":2147483647,
	"altBody":"String content",
	"body":"String content",
	"fromEmail":"String content",
	"fromName":"String content",
	"language":"String content",
	"listIds":[2147483647],
	"published":2147483647,
	"replyToEmail":"String content",
	"replyToName":"String content",
	"subject":"String content",
	"visible":true
}

 

13. update-recpient

Funzione di invio: POST

Con questa funzione puoi sostituire i campi personalizzati di una newsletter. La funzione accetta i seguenti parametri:

  • apiUser – nome d’utente per accedere all’API
  • apiKey – parola chiave per accedere all’API
  • id – ID numero della newsletter, alla quale desideri sostituire i campi personalizzati
  • email – indirizzo email del destinatario
  • name – nome del destinatario
  • listIds – ID numero delle liste, alle quali il destinatario verrà iscritto. L’esempio del formato è il seguente [4,6]. L’ID della lista lo trovi con queste istruzioni. Se il destinatario era già prima iscritto su altre liste, le vecchie iscrizioni si cancelleranno in si sostituiranno con quelle nuove.
  • html – se il destinatario accetta i messaggi in formato HTML oppure solo in quello testuale.
  • confirmed – se il destinatario consente di accettare i messaggi (i messaggi saranno comunque inviati).
  • enabled – se il destinatario è abilitato (i destinatari non abilitati non esistono)
  • accept – se il destinatario accetta i messaggi
  • customAttributes – lista delle coppie di chiavi, valori (key, value) per i campi personalizzati del destinatario su misura. Per il nome del campo usa lo spazio »nome del campo personalizzato«, che è disponibile tramite l’interfaccia utente grafica.

Esempio:

{
	"apiKey":"String content",
	"apiUser":"String content",
	"id":2147483647,
	"accept":true,
	"confirmed":true,
	"customAttributes":[
		{
		"name":"firstname",
		"value":"John"
		},
		{
		"name":"lastname",
		"value":"Smith"
		}
	],
	"email":"String content",
	"enabled":true,
	"html":true,
	"listIds":[2147483647],
	"name":"String content"
}