Table of Contents
SubscribeSubscribe.aspx
This function is contained in predefined subscription forms: it allows users to sign up to a newsletter using a double opt-in method.
...
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)
This function is similar to the previous one, the main differences lie in the format with which the parameters are defined, and in the fact that "xmlSubscribe" returns an output code with information about the outcome of the operation.
If you wish to create a form that subscribes the user to more than one list at the same time, and sends only one confirmation email, use "subscribe.aspx" API described above.
...
Third level domain name for a console
Xmlchksubscriber.aspx (User subscription check)
This function performs a check on a user subscription status
URL: http://newsletter.domainname.tld/frontend/xmlChkSubscriber.aspx
...
PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
RETURNED VALUES:
CODE | DESCRIPTION |
1 | Generic error / user not subscribed |
2 | User subscribed (OPT-IN) |
3 | User unsubscribed (OPT-OUT) |
4 | User subscription to be confirmed (PENDING) |
NOTE:
Code 1 is given as output value both in case of error (e.g. when ListGuid code does not match ListID) and when the user is not subscribed.
Xmlunsubscribe.aspx (User unsubscription)
This function forces the unsubscription of a user from a list.
...
NOTE:
If successfully unsubscribed, the user will be moved to unsubscribed and will receive an unsubscription confirmation email, if this option has been selected
Updsubscriber.aspx (User update)
This function allows to update a user's personal data.
URL: http://newsletter.domainname.tld/frontend/xmlUpdSubscriber.aspx
PARAMETERS AT ENTRANCE:
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
Replace | N | Parameter to enable or disable group replacement for the specified user. Accepted values: 0/1/false/true – Default value: false |
Group | N | Groups to which to subscribe the user |
csvFldNames | N | Personal data codes (separated by ";" character) |
csvFldValues | N | Values related to personal data codes (separated by ";" character) |
(1) either email or sms parameter must be specified
(2) if blank, international code for Italy will be used (0039)
RETURNED VALUES:
CODE | DESCRIPTION |
0 | Data updated successfully |
1 | Generic error |