Page tree
Skip to end of metadata
Go to start of metadata
IMPORTANT: Fax channel and "regular mail" (snail mail) are deprecated.

 

Updates a list

Method parameters

  • string UpdateList(string accessKey, int listID, bool copyTemplate, Option[] options)
    • accessKeyaccess 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*
      • description: list description
      • format: list format (allowed values = html, text)
      • charset: text charset (see a list of Supported Charsets)
      • 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 (max 11 chars for alphanumeric senders)
      • optout_type: optout type (0: One-click unsubscribe, 1: , 2: )
      • frontendform: flag** that allows to view the subscription forms in the frontend
      • headerxabuse: heading added to the messages in the list
      • kbmax: message size beyond which a warning is generated
      • headerreplyto: email address** for replies to the newsletter
      • headerlistunsubscribe: heading added to the messages in the list
      • multipart_text: flag** to automatically generate a text version of the message at sending stage
      • default_prefix: default international prefix for mobile numbers (e.g. 0044)
      • 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

*if you specify an unverified address you shall access to web application to complete verification process before sending
**allowed values = 0,1

SOAP Examples

SOAP Response
<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>
<msiCompanyName></msiCompanyName>
<msiContactName></msiContactName>
<msiAddress></msiAddress>
<msiCity></msiCity>
<msiStateOrProvince></msiStateOrProvince>
<msiPostalCode></msiPostalCode>
<msiCountry></msiCountry>
<msiPhone></msiPhone>
<msiWebSiteUrl></msiWebSiteUrl>
<msiPermissionReminder></msiPermissionReminder>
</list>
</UpdateListResult>

Code Examples

Ruby
# 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>"
  • No labels