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 2 Next »

Method parameters

CreateList_st method allows to create a new list in MailUp, using default values for lists. For new integrations with MailUp it has to be preferred to similar method MailUpSend.CreateList.

This method is used when an external application managing several companies/brands uses one single MailUp console. An example of this is the integration between MailUp and Microsoft Dynamics CRM: one CRM system and one MailUp console allow to manage different companies. Adding a new company is an operation entirely managed in the CRM system, which then creates within MailUp a new list, independent from the others. We recommend to limit the number of lists, in order to preserve the optimal performance of the MailUp console.

 

  • string CreateList_st(string accessKey, string name, stringautoId)
    • accessKey: access key obtained using the LoginFromId method
    • name: list identifier
    • autoId: identifier which allows MailUp to know if a list was created in an automated context or not. In the Microsoft Dynamics CRM it corresponds to the ORGUNIQUENAME. If this value is null, or an empty string, the list will not be associated to an automatic creation

 

Sample CreateList_st request

CreateList_st
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ws="http://services.mailupnet.it/WS">
   <soap:Header/>
   <soap:Body>
      <ws:CreateList_st>
         <!--Use accessKey value that is returned by LoginFromId method-->
         <ws:accessKey>HzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9</ws:accessKey>
         <ws:name>My new list</ws:name>
         <ws:autoId>MYUNIQUEID</ws:autoId>
      </ws:CreateList_st>
   </soap:Body>
</soap:Envelope>

 

Sample CreateList_st response

The method returns a string in XML format containing the list identifier and the GUID of the List created in the MailUp console.

CreateList_st response
<CreateList_st>
   <errorCode>0</errorCode>
   <errorDescription></errorDescription>
   <Lists>
      <List Guid="236aea05-97f0-4686-ac46-fd92c0f0" Id="2" Name="List created by CreateList_st"></List>
   </Lists>
</CreateList_st>


The XML string will have the following features:

  • One root node <CreateLists_st>.
  • One <errorCode> node, that contains the error ID (zero when successful)  
  • One <errorDescription> node, that contains the error details (empty when successful)  
  • One node <Lists>, contained in the root node.
  • One node <List> with the attributes Guid, Id and Name. These contain respectively the GUID of the list, the ID of the list and the name of the list provided at entrance.


In case of errors during the creation of the list a suitable error code and error description will be returned.

CreateList_st method will also create the folder to be used for transferring CSV files required by MailUpSend.SendNewsletterNL method.

  • No labels