Overview
When you attempt to use the CreateList or DeleteList API calls, you receive an error message that indicates you do not have the required permissions. You would like information on how to complete these API calls successfully.
Information
Since the release of ListManager version 11.b, AdminName (create only), AdminEmail, and AdminPassword were introduced as required fields for these API calls. You must have an account that is either a Site Administrator or a Server Administrator to Create or Delete a List in LitManager.
CreateList
Creates a new list and returns the newly created listID.
| Argument | Description |
| ListType | The type of list to be created, from ListTypeEnum |
| ListName | The name of the list (string) |
| ShortDescription | A short description of the list (string) |
| AdminName | The name of the list administrator (string) |
| AdminEmail | The email address of the list administrator (string) |
| AdminPassword | The password of the list administrator (string) |
| Topic | The category the mailing list belongs to (char) If no topic is specified, revert to previous (v1.5.2) behavior. |
Returns: New List ID (int)
ListTypeEnum
| Type | Description |
| marketing |
All list settings will be appropriate for a list intended for email marketing. The list will be configured so only administrators may send email to the list. If members reply to the message, their responses will go to the message’s author. Open and Clickthrough tracking is on by default for all new mailings sent from an email marketing list. Full personalization of messages (conditional content, mail merge) is possible because full scripting is enabled for administrators. The list will accept messages from other lists as a child list. Mailing and clickthrough data will be kept forever. Messages sent to the list must be approved before they will be sent. The list settings may be changed later in the Utilities: List Settings menu. |
| announcement-moderated |
All list settings will be appropriate for a one-way announcement list. The list will be configured so only administrators may send email to the list. If members reply to the message, their responses will go to the message’s author. Open and Clickthrough tracking is off by default for all new mailings sent from an announcement list. Messages can be personalized because safe scripting is enabled for administrators. The list will not accept messages from other lists as a child list. Mailing and clickthrough data will be kept for 35 days. Messages sent to the list must be approved before they will be sent. The list settings may be changed later in the Utilities: List Settings menu. |
| discussion-moderated | All list settings will be appropriate for a moderated discussion list. The list will be configured so that all list members may send email to the list. If members reply to the message, their responses will go to the list. Messages sent to the list must be moderated by an administrator. |
| discussion-unmoderated | All list settings will be appropriate for an unmoderated discussion list. The list will be configured so that all list members may send email to the list. If members reply to the message, their responses will go to the list. |
DeleteList
| Argument | Description |
| ListName | The name of the list to be deleted (string) |
| AdminEmail | The email address of the list administrator (string) |
| AdminPassword | The password of the list administrator (string) |
Returns: True if successful (bool)
Application
For details on using the API, see the ListManager API Help
Priyanka Bhotika
Comments