Description
Updates subscriber list information.
Request Parameters
- APIKey = {string} (required)
- The API key you are using to authenticate the access.
- Command = {List.Update} (required)
- API Command
- ResponseFormat = {JSON | XML} (required)
- Response format
- JSONPCallBack = {bool}
- Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
- SubscriberListID = {integer} (required)
- ID of the subscriber list to be updated.
- Name = {string} (required)
- name of the subscriber list.
- OptInMode = {Single | Double} (required)
- Opt-in mode of the subscriber list.
- OptInConfirmationEmailID = {integer} (required)
- ID number of the email which will be used for sending opt-in confirmation email (required if opt-in mode is set to double)
- OptOutScope = {This list | All lists} (required)
- Opt-out scope of the subscriber list.
- OptOutAddToSuppressionList = {Yes | No} (required)
- Set 'Yes' to add unsubscribed email address into the suppression list
- SendServiceIntegrationFailedNotification = {true | false} (required)
- If set to true, a notification email will be sent to list owner when a web service integration fails.
- SubscriptionConfirmationPendingPageURL = {string} (required)
- URL of the subscription confirmation pending page. This page is showed only in double opt-in lists.
- SubscriptionConfirmedPageURL = {string} (required)
- URL of the subscription confirmed page.
- HideInSubscriberArea = {true | false} (required)
- If set to true, subscriber list will not be shown in subscriber area.
Response Parameters
- Success = {true | false}
- States if there is an error or not
- ErrorCode = {integer}
- If there is an error, error's code
Error Codes
- 1
- Subscriber list id is missing
- 2
- Invalid subscriber list id
- 3
- Invalid opt-in mode
- 4
- Invalid opt-out scope
- 5
- Invalid send service integration notification setting
- 6
- Invalid setting
- 7
- Opt in confirmation email id is missing
- 8
- Synchronization fields must be filled in
- 9
- Invalid email address for request processing
- 10
- Invalid add to suppression list on opt-out event value
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges