...
(1) at least one between email or sms parameters must be specified
(2) if the prefix is not specified, default settings for the list will be used
RESPONSE 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) |
| Info |
|---|
| 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 a subscribed user. |
Code Examples
| Code Block | ||||
|---|---|---|---|---|
| ||||
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information. require 'mailup' m = MailUp::API.new('console_url') m.xml_chk_subscribe(:listGuid => 'abc123', :list => 1, :email => 'sample@email.com') # => 2 |
Xmlunsubscribe.aspx (User unsubscription)
...
(1) at least one between email or sms parameters must be specified
(2) if the prefix is not specified, default settings for the list will be used
RESPONSE VALUES
CODE | DESCRIPTION |
0 | User unsubscribed successfully |
1 | Generic error |
3 | User unknown / already unsubscribed |
| Info |
|---|
| NOTE: If successfully unsubscribed, the user will be moved to unsubscribers and will receive an unsubscription confirmation email, if this option has been selected |
Code Examples
| Code Block | ||||
|---|---|---|---|---|
| ||||
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::API.new('console_url')
m.xml_unsubscribe(:listGuid => 'abc123', :list => 1, :email => 'sample@email.com')
# => 0 |
Updsubscriber.aspx (User update)
This function allows to update a user's personal data.
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/Updsubscriber.aspx
REQUEST PARAMETERS
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 the ";" character) |
csvFldValues | N | Values related to personal data codes (separated by the ";" character) |
(1) at least one between email or sms parameters must be specified
(2) if the prefix is not specified, default settings for the list will be used
RESPONSE VALUES
CODE | DESCRIPTION |
0 | Data updated successfully |
1 | Generic error |
Code Examples
| Code Block | ||||
|---|---|---|---|---|
| ||||
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::API.new('console_url')
m.upd_subscriver(:listGuid => 'abc123', :list => 1, :email => 'sample@email.com')
# => 0 |