Subscriber.Unsubscribe

Description

Unsubscribe the subscriber from the list

Request Parameters

SessionID = {string} (optional)
Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command = {Subscriber.Unsubscribe} (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
ListID = {integer} (required)
Subscriber List ID
CampaignID = {integer} (required)
If link is generated for an email campaign, campaign ID should be provided for statistics
EmailID = {integer}
If email ID is provided, the unsubscription statistics will be registered to that email and owner A/B split testing campaign
SubscriberID = {integer} (required)
Subscriber ID or email address must be provided
EmailAddress = {string} (required)
Subscriber ID or email address must be provided
IPAddress = {string} (required)
IP address of the user who has requested to unsubscribe
Preview = {1 | 0} (required)
If set to 1, unsubscription process will be simulated

Response Parameters

Success = {true | false}
States if there is an error or not
RedirectURL = {string}
Target URL to redirect user after the process
ErrorCode = {integer}
If there is an error, error's code

Error Codes

1
Subscriber list ID is missing
2
IP address is missing
3
Email address or subscriber ID must be provided
4
Invalid subscriber list ID
5
Invalid user information
6
Invalid email address format
7
Invalid subscriber ID or email address. Subscriber information not found in the database
8
Invalid campaign ID
9
Email address already unsubscribed
10
Invalid email ID
99998
Authentication failure or session expired
99999
Not enough privileges