PARAMETRI RICHIESTA

Parametro Tipo di dato Richiesto Definizione
SessionID string Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command string The API Command sended to the console
ResponseFormat JSON | XML 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 The unique console ID of subscription list
CampaignID integer 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 Subscriber ID or email address must be provided
EmailAddress string Subscriber ID or email address must be provided
IPAddress string IP address of the user who has requested to unsubscribe
Preview bool If is TRUE, unsubscription process will be simulated

PARAMETRI DI RISPOSTA

Parametro Tipo di dato Definizione
Success bool States if an error has been generated during last command execution or not
RedirectURL string Target URL to redirect user after the process
ErrorCode integer The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred.

CODICI DI ERRORE

Codice Definizione
99999 Not enough privileges
99998 Authentication failure or session expired
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