...
Xmlsubscribe.aspx (User subscription)
This function call is similar to the previous one: the main differences is 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, when instructed to do so.
URL
The URL to use depends on your MailUp account's unique URL. If your MailUp admin console address is xyzw.espsrv.com, the correct action URL for the form (the URL of the form handler) will be http://xyzw.espsrv.com/frontend/xmlSubscribe.aspx
...
Name | Mandatory? | Description |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
List | Y | List IDs: you can specify more than one list using comma as separator. |
Group | N | Groups to which to subscribe the user (comma separated) |
Confirm | N | Parameter to enable ("1" or "true") or disable ("0" or "false") the confirmation request email. Default value: 1 (i.e. double opt-in enabled by default). |
csvFldNames | N | Personal data codes (separated by the ";" character) |
csvFldValues | N | Values related to personal data codes (separated by the ";" character) |
retCode | NParameter to enable or disable the return of an output code for the call. Accepted values: 0/1 – Default value: 0 | Set it to 1 to receive a response code instead of a text string. It defaults to 0. |
Dynsndmail(3) | N | "dynamic sender e-mail address" Sender address in the confirmation request email (If blank, default value for the list will be used) |
dynsndname(3) | N | "dynamic sender name" Sender name in the confirmation request email (If blank, default value for the list will be used) |
| ConfirmListID(4) | N | To be used only when more list IDs are specified in "List" parameter. ConfirmListID is the ID of the list that contains the confirmation request message to be sent to pending subscribers. Confirmation request is sent if recipient is pending in at least one of the specified lists |
(1) at least one between email or sms parameters must be specified
(2) if the prefix not specified, default settings for the list will be used
(3) for further details on how to use these fields, please see the section about the "subscribe.aspx" API (top of this page)
(4) ConfirmListID parameter is available on MailUp 8.3.1 or more recent versions
RESPONSE VALUES
Make sure that the retCode parameter is set to 1 to receive a response code. Otherwise a text string is returned.
| CODE | DESCRIPTION |
|---|---|
| 0 | Operation completed successfully / Either email address or mobile number has been changed |
| 1 | Generic error |
| 2 | Invalid email address or mobile number |
| 3 | User already subscribed |
| -1011 | IP not registered |
...