Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »


Method parameters

Creates a list

  • string CreateList(string accessKey, string name, string defaultSettings, bool copyTemplate, Option[] options)
    • accessKey: access key obtained using the Login method
    • name: list name
    • defaultSettings: if set as "default" it uses the default settings for all the lists, if it is an ID it uses the default settings for the corresponding list
    • copyTemplate: if set as "true" it copies the default templates for the list
    • 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 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 name
      • optout_type: optout type (1: Single with confirmation, 2: Single, 3: Double)
      • 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



  • Fax channel is currently available for the Italian market only.
  • If you create a list after authenticating with WS username (i.e. a+consoleID username) and you access to MailUp application console using a different user you will not see created list in the list dropdown menu; anyway, if you logged in with an administrator user you can go to "Settings > Console Settings > User Permission" and add created list to the lists that are accessible for that user
  • CreateList fails if you have deleted all MailUp lists on your console by using DeleteList method, please keep at list one MailUp list


Sample CreateList response


Code Examples

# Refer to for gem information.
require 'mailup'
m ='api-username', 'api-password')
m.create_list(:name            => "List Name",
              :defaultSettings => "default",
              :copyTemplate    => true,
              :options         => {
                "OwnerEmail"   => "",
                "BouncedEmail" => "",
# Returns XML response
# => "<InsertListResult><errorCode>0</errorCode><errorDescription></errorDescription><list> ... </list></InsertListResult>"
  • No labels