API technical details

Subscribe.aspx

This function is contained in predefined subscription forms: it allows users to sign up to a newsletter using a double opt-in method.

Form must be structured as follows, while “name” attributes can be drawn from the page Settings > Codes table in the MailUp console. Please note that any “type” can be set for all parameters, as it is arbitrary.

Subscription form action:

<form method="post" action="http://esempio.emailsp.net/frontend/subscribe.aspx">

Action address is linked to the console address. If the console address is xyzw.espsrv.com, correct action is http://xyzw.espsrv.it/frontend/subscribe.aspx. Parameters for calling subscribe.aspx function are described below

Email field (mandatory):

<input name="email" type="text" size="60" maxlength="100"> 

Fields related to distribution lists (mandatory):

<input type="hidden" name="list" value="1"> 

If you wish to let the user choose more than one list, it is possible to list them using the same name every time, for example:

<input name="list" type="checkbox" value="2">Seconda lista <br>


<input name="list" type="checkbox" value="3">Terza lista <br> 

If you wish to subscribe a user to more than a list, without him choosing one of them, you can use:

<input type="hidden" name="list" value="1,2,3"> 

In case a user subscribes to more than a list, the system will send just one confirmation email, which will enable the subscription to all the lists. Conventionally, the system will use the confirmation email and the message pages of the first of the enabled lists (list 1 in the example above)

The “value” field must contain the ID of the list the user subscribes to; list ID can be found at the page Settings > Edit lists or looking at the dropdown menu at the top left of the page. In the image below, the list called "Business" has value=3.

Dropdown menu for list selection

Mobile number (optional): To record the mobile number the following fields must be added to the form:

<input id="prefix" value="0039" type="text" name="prefix" />
<input id="sms" type="text" name="number" />

Please note that the field “prefix” (international prefix) need not be entered as a separate field, it can also be inserted in the field “number”. Anyway we suggest that it should be kept separated for clarity’s sake.

Groups (optional): 

<input name="group" type="checkbox" value="1"> First group <br>
<input name="group" type="checkbox" value="2"> Second group <br> 

If you want the user to be subscribed to different groups, without choice, type must be “hidden”, as in the example given below:

<input name="group" type="hidden" value="2,8,10"> 

This way, the user is automatically subscribed to groups 2,8 and 10. Group IDs are listed at the page Settings > Codes table in the MailUp console.

Personal data fields (optional):

<input name="campo1" type="text" size="60" maxlength="100"> Name
<input name="campo2" type="text" size="60" maxlength="100"> Surname 

In the form it is the customer’s responsibility to set the fields, dropdown menus, colors, styles, checkboxes, controls, freely based on one’s needs. The fields which are not necessary can be removed from the registration form. Standard MailUp nomenclature “field1”, “field2”,… “fieldN” must be used. If there are extra fields with names which are not recognized, they will be ignored.

All parameters to be passed (name=list, group, field1, field2…) can be of any type (type=checkbox, text, radio, button…) and they can assume any value.



Example of Codes Table

Campi per modificare nome e/o indirizzo e-mail del mittente:

<input type="hidden" name="dynsndmail" value="email@example.com" > 
<input type="hidden" name="dynsndname" value="Name Surname"> 

It is possible to specify the fields above in case you should want to replace the default values for the list.

These fields allow to send a subscription confirmation message with personalized sender, and, in case both have been specified, they will be set as key values in the “From” field, while the default name and email address for the MailUp list will be used for the “Sender” field. So, on many clients this message will be viewed as “sent by Sender on behalf of From”. A confirmation email like this contains a link to the newsletter management system to complete the subscription, while, if the recipient replies to the email message (“Reply to”), the reply will be sent to the address indicated in the “From” field. This practice is very useful when a confirmation email is sent to an acquaintance: the invitation is much more effective if the person who invites is among the senders of the email (in the “From” field).

Anyway, filling up this fields is optional: in case neither of them has been specified the confirmation request email will be sent using the default list values to fill the “From” field.

Xmlsubscribe.aspx (User subscription)

Questa funzione è analoga alla precedente, le principali differenze consistono nel formato con cui si specificano i parametri e nal fatto che la xmlSubscribe restituisce un codice di ritorno con informazioni sull'esito dell'operazione. 
Per creare un form che iscrive a più liste contemporaneamente, inviando una sola email di richiesta conferma, utilizzare l'API subscribe.aspx descritta nel precedente paragrafo. 
URL: http://newsletter.nomedominio.tld/frontend/xmlSubscribe.aspx (sostituire la parte in rosso con il dominio di terzo livello corretto)
(OBBL. = Obbligatorio) 
PARAMETRI IN INGRESSO:

⁽¹⁾ deve essere specificato almeno uno dei parametri email e sms
⁽²⁾ se non specificato verrà utilizzato il prefisso internazionale italiano (0039)
⁽³⁾ per ulteriori dettagli sull'utilizzo di questi campi consultare la descrizione dei campi omonimi per la pagina subscribe.aspx 

VALORI RESTITUITI

Nota: per conoscere il dominio di terzo livello utilizzato è sufficiente entrare in MailUp e guardare l'indirizzo della propria console. Ad esempio in figura sotto tale dominio è "v73.s02.it" 
 
Figura 13: indicazione del dominio di terzo livello per una certa console 

Xmlunsubscribe.aspx (User unsubscription)

Questa funzione forza la disiscrizione di un utente da una lista. 
URL: http://newsletter.nomedominio.tld/frontend/xmlUnSubscribe.aspx 
PARAMETRI IN INGRESSO:

⁽¹⁾ deve essere specificato almeno uno dei parametri email e sms
⁽²⁾ se non specificato verrà utilizzato il prefisso internazionale italiano (0039) 
VALORI RESTITUITI

NOTA:
In caso di esito positivo l'utente verrà spostato tra gli opt-out e gli verrà inviata una email di conferma dove previsto

Updsubscriber.aspx (User update)