Unsubscription (Subscriber.Unsubscribe)

Description

This command will allow you to unsubscribe an existing email addresses from target subscriber list.

Input Parameters

Command=Subscriber.Unsubscribe [required]

Required command to perform API request

ResponseFormat [optional] [default=XML]

Defines the response data format. It can be equal to XML or JSON .

SessionID [required]

Your session ID. In order to run this API call, you need to be logged in and have session ID.

ListID [required]

ID number of the target subscriber list

EmailAddress [required]

Email address that is going to be unsubscribed

UnsubscriptionIP [required]

IP address of the subscriber

Output Parameters

Success [true or false]

If an error has occurred, this parameter will be equal to false. Otherwise it will be set to true.

ErrorCode [integer]

If an error has occurred, this parameter will contain error codes. Otherwise it will be set to 0.

SessionID [string]

If login was successful, this parameter will contain the session ID that you will need on your following API calls.

RedirectURL [string]

The target URL that subscriber will be redirected after the process

Error Codes

#1

List ID is missing

#2

Email address is missing

#3

Subscriber list not found

#4

Invalid email address format

#5

Email address doesn't exist in the list

#6

Invalid email address

#7

Unsubscription IP address is missing

#9998

Unauthorized access. User login required to execute this API call.

#9999

Invalid API call. Please check the API command and try again.