...
...
...
Info |
---|
IMPORTANT: Fax channel and "regular mail" (snail mail) are deprecated. |
Updates a list
Method parameters
- string UpdateList(string accessKey, int listID, bool copyTemplate, Option[] options)
- accessKey:
...
- owneremail: indirizzo mittente
- bouncedemail: indirizzo per i messaggi di errore
- description: descrizione della lista
- format: formato della lista ("html", "text")
- charset: charset del testo (vedere sezione "charset ammessi")
- public: flag che indica se la lista è visibile nel frontend
- tracking: flag che abilita il tracciamento delle aperture
- nl_sendername: nome mittente email
- sms_sendername: nome mittente sms
- optout_type: tipo optout (1: Singolo con pagina conferma, 2: Singolo, 3: Doppio)
- sendemailoptout: flag che invia o meno la mail ai disiscritti.
- 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 conversionlab
- default_prefix: prefisso internazionale di default per gli sms
- multi_optout_list: elenco di liste che compariranno all'utente nel caso di opt-out multiplo (es.:
- access key obtained using the LoginFromId method
- listID: ID of the list to be modified
- options: array of values for options setting:
- owneremail: sender email address*
- description: list description
- format: list format (allowed values = html, text)
- charset: text charset (see a list of /wiki/spaces/mailupapi/pages/36339743)
- 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 (max 11 chars for alphanumeric senders)
- optout_type: optout type (0: One-click unsubscribe, 1: , 2: )
- frontendform: flag** that allows to view the subscription forms in the frontend
- headerxabuse: heading added to the messages in the list
- kbmax: message size beyond which a warning is generated
- headerreplyto: email address** for replies to the newsletter
- headerlistunsubscribe: heading added to the messages in the list
- multipart_text: flag** to automatically generate a text version of the message at sending stage
- default_prefix: default international prefix for mobile numbers (e.g. 0044)
- 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
- 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
*if you specify an unverified address you shall access to web application to complete verification process before sending
**allowed values = 0,1
SOAP Examples
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<UpdateListResult>
<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>
<kbmax></kbmax>
<headerreplyto></headerreplyto>
<displayas></displayas>
<headerlistunsubscribe></headerlistunsubscribe>
<smtp_confirm></smtp_confirm>
<multipart_text></multipart_text>
<conversionlab_trackcode></conversionlab_trackcode>
<default_prefix></default_prefix>
<multi_optout_list></multi_optout_list>
<subscribedemail></subscribedemail>
<sendconfirmsms></sendconfirmsms>
<senderfaxname></senderfaxname>
<senderfax></senderfax>
<senderfirstname></senderfirstname>
<senderlastname></senderlastname>
<sendercompanyname></sendercompanyname>
<senderaddress></senderaddress>
<senderpostalcode></senderpostalcode>
<sendercity></sendercity>
<senderprovince></senderprovince>
<senderstate></senderstate>
<msiCompanyName></msiCompanyName>
<msiContactName></msiContactName>
<msiAddress></msiAddress>
<msiCity></msiCity>
<msiStateOrProvince></msiStateOrProvince>
<msiPostalCode></msiPostalCode>
<msiCountry></msiCountry>
<msiPhone></msiPhone>
<msiWebSiteUrl></msiWebSiteUrl>
<msiPermissionReminder></msiPermissionReminder>
</list>
</UpdateListResult> |
Code Examples
Code Block | ||||
---|---|---|---|---|
| ||||
# 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.update_list(:listID => 1,
:options => {
"Owneremail" => "owner@email.com",
"Bouncedemail" => "bounced@email.com",
...
})
# Returns XML response
# => "<GetListsResult><errorCode>0</errorCode><errorDescription></errorDescription><lists> ... </lists></GetListsResult>" |