Update List Definition

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=updatelistdefinition
c=updatelistdefinition

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]
r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]
p=[password]

List Name

Yes

Name of the list definition to update. To include spaces, use + or %20 to avoid possible issues with spaces in a URL.

list_name=[list_name]

Description

A short description of the list definition.

description=[text]

Template

The default template associated with the list definition.  You can obtain a list of template IDs using the command show_templates.

template_id=[template_id]

From Address

Email address the message appears to be sent from.  Though not required to update a list, a From address should always be defined before sending a list.  It can be a simple email address, or can include a decorative portion in addition to the email address. 

from=[email_address]
from=["Decorative"%20 <email_address>]

Reply To Address

Email address to send replies.  A Reply To address should always be defined before sending messages from a list.  It can be a simple email address, or can include a decorative portion in addition to the email address.

reply_to=[email_address]
reply_to=["Decorative"%20 <email_address>]

Bounce Address

Mailbox to catch bounce replies.  If not defined, no bounce tracking will occur.

errors_to=[bounce_address]

Email address to receive notifications when Campaigns have been sent or failed.  These notifications are in addition to the normal notifications sent to the User who deployed the Campaign.  

admin_email=[admin_email_address]

Identifier of the default Account Profile to use when deploying a campaign and filling the tags in content. Use Get Account Profile to find the ID.

acct_pro_id=[account_profile_id]

DEFAULT==Account Default Profile

Comma separated list of identifiers of custom keywords to identify and report items that have a similar use or purpose.

labels=[label_id(s)]

folder_id=[folder_id]

DEFAULT==0

To require Contacts to confirm subscription requests, set the flag to '1'.  If the Flag is set, then the three additional fields are optional.
If no From Address is defined, it will use the List's From address.  
If no Template is defined, it will use a system default message.
If no Format is defined, the default is Plain Text.  Formats include:

• 1 = Plain Text
• 2 = HTML

subscribe_confirmation_flag=[0,1]

DEFAULT==0

subscribe_confirmation_from_address=[email]
subscribe_confirmation_template_id=[template_id]
subscribe_confirmation_format=[1,2]

DEFAULT==1

To send a courtesy welcome message when Contacts request subscription, set the flag to '1'.  If the Flag is set, then the three additional fields are optional.  

If no From Address is defined, it will use the List's From address.  
If no Template is defined, it will use a system default message.
If no Format is defined, the default is Plain Text.  Formats include:

• 0 = Contact Selected Format
• 1 = Plain Text
• 2 = HTML
• 99 = Multipart MIME

subscribe_courtesy_flag=[0,1]

DEFAULT==0

subscribe_courtesy_from_address=[email]
subscribe_courtesy_template_id=[template_id]
subscribe_courtesy_format=[0,1,2,99]

DEFAULT==1

To send a courtesy farewell message when Contacts unsubscribe from a list, set the flag to '1'.  If the Flag is set, then the three additional fields are optional.  

If no From Address is defined, it will use the List's From address.  
If no Template is defined, it will use a system default message.
If no Format is defined, the default is Plain Text.  Formats include:

• 0 = Contact Selected Format
• 1 = Plain Text
• 2 = HTML
• 99 = Multipart MIME

unsubscribe_courtesy_flag=[0,1]

DEFAULT==0

unsubscribe_courtesy_from_address=[email]
unsubscribe_courtesy_template_id=[template_id]
unsubscribe_courtesy_format=[0,1,2,99]

DEFAULT==1

default_automation_flag=[0,1]
default_automation_campaign_id=[automation_id]

DEFAULT==0

Subscribe Landing Page

subscribe_landing_page_url=[URL]

Unsubscribe Landing Page

unsubscribe_landing_page_url=[URL]

track_clicks=[0,1]

DEFAULT==0

track_opens=[0,1]

DEFAULT==0

Base URL

Customize the tracking URL by defining a Base URL ID.

base_url_id=[base_url_id]

Customize the IP to use for publishing by defining a VMTA ID.

vmta=[vmta_id]

Define URLs to customize the form and landing pages for each list by entering the fully qualified URL to the content in the correct FTAF field. 

If the FTAF form will be used on a webpage instead of in an email, set the Allow Anon flag to '1'.

To use the List from address instead of sender's address, set From flag to '1'.

ftaf_custom_form_url=[URL]
ftaf_envelope_url=[URL]
ftaf_landing_page_url=[URL]
ftaf_error_landing_page_url=[URL]

ftaf_allow_anon_flag=[0,1]

DEFAULT==0

ftaf_user_list_from_flag=[0,1]

DEFAULT==0

To send only one message per email address when the resulting List is deployed, set the flag to '1'.  

dedupe_on_send_flag=[0,1]

DEFAULT==0

To to aggregate all tracking from any Campaign sent over time via the resulting List into a single Campaign report, set the flag to '1'.

sticky_campaign_flag=[0,1]

DEFAULT==0

• mailto%3aemail@domain.com
• http%3a%2f%2fwww.domain.com%2fpage

list_unsubscribe_flag=[0,1]

DEFAULT == 0

list_unsubscribe_email=mailto%3a[email]
list_unsubscribe_http=http%3a%2f%2f[url]

Identifier of the macro to use to set the value of one to three custom fields for each contact when a campaign is deployed using the resulting List.

set_data_macro_id=[set_data_macro_id]

To require approval before deploying campaigns from the resulting list, set the flag to '1'.  If set, the email is required.  Email allows a comma separated list of one or more email addresses. 

workflow_flag=[0.1]
workflow_email_addresses=[email(s)]

DEFAULT==0

sync_flag=[0,1]

DEFAULT==0

sync_open=[event_macro_id]
sync_click=[event_macro_id]
sync_opt_in=[event_macro_id]
sync_opt_out=[event_macro_id]
sync_soft=[event_macro_id]
sync_hard=[event_macro_id]
sync_complaint=[event_macro_id]
sync_send=[event_macro_id]