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
EmailAddress string The email address you want to subscribe
CustomFieldX array Additional information about the subscriber. Replace X with the ID number of the custom field (i.e. CustomField12, CustomField35, etc.)
IPAddress string The IP address of subscriber or remote address
Mobile string The mobile number of subscriber
TriggerAutoresponder Bool Enable or disable Autoresponders and Automation Flows of the list when the subscription event happen. Default is false, disabled.

PARAMETRI DI RISPOSTA

Parametro Tipo di dato Definizione
Success bool States if an error has been generated during last command execution or not
SubscriberID integer If the command successes a SubscriberID is returned
RedirectURL string Target URL to redirect user after the process
ErrorCustomFieldID integer If there's an error with one of the provided custom fields, custom field ID number will be provided
ErrorCode integer The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred.
ErrorCustomFieldTitle string If there's an error with one of the provided custom fields, custom field title will be provided
ErrorCustomFieldDescrizione string If there's an error with one of the provided custom fields, error message returned

CODICI DI ERRORE

Codice Definizione
1 Target subscriber list ID is missing
2 Email address is missing
3 IP address of subscriber is missing
4 Invalid subscriber list ID
5 Invalid email address
6 One of the provided custom fields is empty. Custom field ID and title is provided as an additional output parameter
7 One of the provided custom field value already exists in the database. Please enter a different value. Custom field ID and title is provided as an additional output parameter
8 One of the provided custom field value failed in validation checking. Custom field ID and title is provided as an additional output parameter
9 Email address already exists in the list
10 Unknown error occurred
11 Invalid user information
99998 Authentication failure or session expired
99999 Not enough privileges
12 Mobile number is not valid.
13 Mobile already exists in the list.