Versions Compared

Key

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

...

...

...

Info
IMPORTANT: Fax and regular mail channels are currently available for the Italian market only.

Method parameters

Creates a list

string CreateList(string accessKey, string name, string defaultSettings, bool copyTemplate, Option[] options)
accessKey: chiave di accesso ottenuta chiamando il metodo Login access key obtained using the Login method
name: nome della listalist name
defaultSettings: se if set as "default" usa i settaggi di default delle liste, se corrisponde ad un ID utilizza le impostazioni di base della lista corrispondente
copyTemplate: Se impostato a true copia i template di default per la lista
options: array con le opzioni da modificare:

...

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 del testo (vedere sezione "charset ammessi"(see a list of supported charsets in the appendix A)
  • public: flag che indica se la lista è visibile nel indicating if the list is visible in the frontend
  • tracking: flag che abilita il tracciamento delle apertureenabling the tracking of opens
  • nl_sendername: nome mittente emailemali sender name
  • sms_sendername: nome mittente sms sender name
  • optout_type: tipo optout type (1: Singolo con pagina confermaSingle with confirmation, 2: SingoloSingle, 3: DoppioDouble)
  • sendemailoptout: flag che invia o meno la mail ai disiscritti.indicating if an email is sent to unsubscribers
  • notifyemail: email di notifica all'amministratore in caso di disiscrizione
  • frontendform: flag che permette di visualizzare le form di iscrizioni nel frontend
  • disclaimer: intestazione aggiunta ai messaggi della lista
  • headerxabuse: intestazione aggiunta ai messaggi della lista
  • kbmax: dimensione del messaggio oltre la quale viene generato un warning
  • replyto: indirizzo di posta a cui verranno inviate eventuali risposte alla newsletter
  • displayas: nome che verrà visualizzato nel campo "A:" nelle newsletter ricevute (campo1,campo2 etc.)
  • headerlistunsubscriber: intestazione aggiunta ai messaggi della lista
  • multipart_text: flag per generare in automatico la versione del messaggio solo testo in fase di invio
  • conversionlab_trackcode: codice per il tracciamento con 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 (field1,field2etc.)
  • 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: prefisso internazionale di default per gli smsdefault international prefix for mobile numbers
  • multi_optout_list: elenco di liste che compariranno all'utente nel caso di opt-out multiplo (es.: detail of the lists which will be viewed by the user in case of multiple optout (e.g. 1,2,3 etc.)
  • subscribedemail: flag per inviare un'email agli utenti appena iscritti
  • sendconfirmsms: flag per inviare un sms agli utenti appena iscritti
  • senderfaxname: nome mittente fax
  • senderfax: numero mittente fax
  • senderfirstname: nome mittente posta cartacea
  • senderlastname: cognome mittente posta cartacea
  • sendercompanyname: azienda mittente posta cartacea
  • senderaddress: indirizzo mittente posta cartacea
  • senderpostalcode: codice postale mittente posta cartacea
  • sendercity: città mittente posta cartacea
  • senderprovince: provincia mittente posta cartacea
  • senderstate: stato mittente posta cartacea

...

  • 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

Sample CreateList response

Code Block
languagehtml/xml
linenumberstrue
<InsertListResult>
<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>
...
...
</list>
</InsertListResult>