WS_MailUpManage.UpdateList

Method parameters

Updates a list

• string UpdateList(string accessKey, int listID, bool copyTemplate, Option[] options)
  • accessKey: access key obtained using the LoginFromId method
  • listID: ID of the list to be modified
  • options: array of values for options setting:
    • owneremail: sender email address
    • bouncedemail: address for error messages
    • description: list description
    • format: list format ("html", "text")
    • charset: text charset (see a list of /wiki/spaces/mailupapi/pages/36339743)
    • public: flag indicating if the list is visible in the frontend
    • tracking: flag enabling the tracking of opens
    • nl_sendername: emali sender name
    • sms_sendername: sms sender name
    • optout_type: optout type (0: One-click unsubscribe, 1: Confirmed unsubscribe, 2: Confirmed unsubscribe with list preferences)
    • sendemailoptout: flag indicating if an email is sent to unsubscribers
    • notifyemail: notification email sent to the administrator in case of unsubscriptions
    • frontendform: flag that allows to view the subscription forms in the frontend
    • disclaimer: heading added to the messages in the list
    • headerxabuse: heading added to the messages in the list
    • kbmax: message size beyond which a warning is generated
    • replyto: email address for replies to the newsletter
    • displayas: name displayed in the "To:" field of the incoming newsletters (campo1,campo2 etc.)
    • headerlistunsubscriber: heading added to the messages in the list
    • multipart_text: flag to automatically generate a text version of the message at sending stage
    • conversionlab_trackcode: code for tracking via conversionlab
    • default_prefix: default international prefix for mobile numbers
    • multi_optout_list: detail of the lists which will be viewed by the user in case of multiple optout (e.g. 1,2,3 etc.)
    • subscribedemail: flag to send an email to new subscribers
    • sendconfirmsms: flag to send a text message to new subscribers
    • senderfaxname: fax sender name
    • senderfax: fax sender number
    • senderfirstname: regular mail sender name
    • senderlastname: regular mail sender surname
    • sendercompanyname: regular mail sender company
    • senderaddress: regular mail sender address
    • senderpostalcode: regular mail sender zipcode
    • sendercity: regular mail sender city
    • senderprovince: regular mail sender province
    • senderstate: regular mail sender state

SOAP Examples

<UpdateListResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription> 
<list>
<listID>1</listID>
<listName>Demo</listName>
<hash></hash>
<name></name>
<description></description>
<format></format>
<charset></charset>
<public></public>
<tracking></tracking>
<unsubscribe></unsubscribe>
<owneremail></owneremail>
<bounceemail></bounceemail>
<header></header>
<footer></footer>
<footercustom></footercustom>
<footermailup></footermailup>
<nl_sendername></nl_sendername>
<sms_sendername></sms_sendername>
<optout_type></optout_type>
<sendemailoptout></sendemailoptout>
<notifyemail></notifyemail>
<frontendform></frontendform>
<disclaimer></disclaimer>
<headerxabuse></headerxabuse>
<kbmax></kbmax>
<headerreplyto></headerreplyto>
<displayas></displayas>
<headerlistunsubscribe></headerlistunsubscribe>
<smtp_confirm></smtp_confirm>
<multipart_text></multipart_text>
<conversionlab_trackcode></conversionlab_trackcode>
<default_prefix></default_prefix>
<multi_optout_list></multi_optout_list>
<subscribedemail></subscribedemail>
<sendconfirmsms></sendconfirmsms>
<senderfaxname></senderfaxname>
<senderfax></senderfax>
<senderfirstname></senderfirstname>
<senderlastname></senderlastname>
<sendercompanyname></sendercompanyname>
<senderaddress></senderaddress>
<senderpostalcode></senderpostalcode>
<sendercity></sendercity>
<senderprovince></senderprovince>
<senderstate></senderstate>
</list>
</UpdateListResult>

Code Examples

# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Manage.new('api-username', 'api-password')
m.update_list(:listID  => 1,
              :options => {
                "Owneremail"   => "owner@email.com",
                "Bouncedemail" => "bounced@email.com",
                ...
              })
# Returns XML response
# => "<GetListsResult><errorCode>0</errorCode><errorDescription></errorDescription><lists> ... </lists></GetListsResult>"