...
This function allows to update a recipient's profile.
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/xmlUpdSubscriber.aspx
REQUEST PARAMETERS
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | Recipient's email address | |
Sms | N (1) | Recipient's mobile number, including country code / international prefix (2) |
Replace | N | Parameter to enable or disable group replacement for the specified recipient. Accepted values: 0/1/false/true – Default value: false |
Group | N | Groups to which to subscribe the recipient (separated by the ";" character) |
csvFldNames | N | Recipient field codes (separated by the ";" character) |
csvFldValues | N | Recipient field values (separated by the ";" character) |
(1) At least one parameter between email and sms must be specified
(2) if the country code / international prefix is not specified, the default setting for the list will be used
RESPONSE VALUES
CODE | DESCRIPTION |
0 | Data updated successfully |
1 | Generic error |
Info |
---|
xmlUpdSubscriber.aspx returns error code = 1 ("generic error") in the following cases:
|
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_subscriber(:listGuid => 'abc123', :list => 1, :email => 'sample@email.com') # => 0 |