The Update List command allows you to change properties of an existing Normal list. The command allows you to specify several components of a list, such as From and Reply To addresses. More advanced List properties must be managed through the web interface or the WebServices API where available.
Update List only supports Normal Lists and does not allow changes to List Definitions or Lists of type Super, Seed, or Smart.
The Update List command requires the following arguments: Command, Realm, Password, and List ID.
api_web?r=myrealm&p=mypass&c=updatelist&list_id=66
The command is ‘updatelist, the realm is ‘myrealm’ and the password is ‘mypass’. The list with id ‘66’ with be updated with no changes.
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?r=myrealm&p=mypass&c=updatelist&list_id=66&list_name=mylist_updated&description=test_list_updated&template_id=42&from="Descriptive"%20<from%40domain.com>&reply_to="Descriptive"%20<reply%40domain.com>&errors_to=mailbox??EMAIL_REF??%40response.domain.com&track_clicks=1&track_opens=1&folder_id=0
Successful results return:
SUCCESS: 66
Results
The Update List commands output either a SUCCESS or FAILURE message.
SUCCESS
The Update List command success message returns the SUCCESS message withe the ID of the updated list. The result format is:
SUCCESS: [list_id]
FAILURE
A Update List command will fail if a list with the same name already exists or invalid data is defined. The result format is:
FAILURE: [Reason]
Arguments
The Update List command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=[updatelist] c=[updatelist] |
|
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 ID | Yes | The ID of the list to update. | list_id=[list_id] |
|
List Name |
|
Name of the list to update. Only include the List Name if you want to change the name, otherwise the command will fail. 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. |
description=[text] |
|
Template |
|
The default template associated with the List. 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 create 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] |
| Track Click-Throughs | If you want to track click-throughs from your messages, set this option to ‘1’. |
track_clicks=[0,1] DEFAULT==0 |
|
| Track Opens | If you want to track opens from your messages, set this option to ‘1’. |
track_opens=[0,1] DEFAULT==0 |
|
| Folder | Identifier of the Folder to associate the List for organization. Default folder is 0, or Unfiled. | folder_id=[folder_id] |