WS_MailUpManage.GetLists

Owned by Massimo Arrigoni (Unlicensed)
Last updated: Nov 15, 2012 by MailUp Dev Team (Unlicensed)Version comment
1 min read

Returns all the available lists and their IDs. If you need also list GUIDs you can use WS_MailUpImport.GetNlLists

Method parameters

  • string GetLists(string accessKey)
    • accessKey: access key obtained using the LoginFromId method

If error code=0, the message will contain the IDs of all the accessible lists.

SOAP Examples

SOAP Response
<GetListsResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<lists>
<list>
<listID>1</listID>
<listName>Lista nr.1</listName>
</list>
<list>
<listID>2</listID>
<listName>Lista nr.2</listName>
</list>
</lists>
</GetListsResult>

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.get_lists
# Returns XML response
# => "<GetListsResult><errorCode>0</errorCode><errorDescription></errorDescription><lists> ... </lists></GetListsResult>"