Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

Method parameters

CreateList method allows to create a new list in MailUp, using default values for lists.


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(string accessKey, string name, string autoId)

...

  • accessKey: chiave di accesso ottenuta chiamando il metodo Login.
  • name: Nome della Lista di MailUp.
  • autoId: Identificativo che permette a MailUp di individuare se una lista è stata creata in un contesto automatizzato o meno. Per Microsoft Dynamics CRM corrisponde all'ORGUNIQUENAME. Se non valorizzato (null o stringa vuota), la lista non sarà associata ad una creazione automatica.

...

    • Un nodo radice <CreateLists>.
    • Un nodo <Lists>, contenuto nel nodo radice.
    • Un nodo <List> che presenta gli attributi Guid, Id e Name. Il primo conterrà il GUID della Lista, il secondo l'identificativo numerico della Lista, il terzo il nome della Lista fornito in ingresso al metodo.

...

  • Un nodo radice <CreateList>.
  • Un nodo <Error>, contenuto nel nodo radice, che riporta il messaggio di errore.

...

  • accessKey: access key obtained using the Login 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 response


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

Esempio di dato restituito dal metodo CreateList

 

Code Block
languagehtml/xml
linenumberstrue
<CreateList>

       <Lists>

<List Guid="Guid" Id ="X" Name="nome"/>

       </Lists>

</CreateList >

The XML string will have the following features:

  • A root node <CreateLists>.
  • A node <Lists>, contained in the root node.
  • A node <List> with the attributes Guid, Id e 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, the XML will have the following structure:

Esempio di dato restituito dal metodo CreateList

 

 

Code Block
languagehtml/xml
linenumberstrue
<CreateList>

       <Lists>

<List Guid="Guid" Id ="X" Name="nome"/>

       </Lists>

</CreateList >

 

 

The XML string will have the following features:

  • A root node <CreateList>.
  • A node <Error>, contained in the root node, returning the error message.

CreateList method will also create the folder to which the CSV files containing the data of the users to be imported will be transferred via FTP.