Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

Subscriber.Subscribe

Description

Subscribes an email address to provided subscriber list or lists

Oempro Version

4+

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.Subscribe} (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)

Target List ID

EmailAddress = {string} (required)

Email address to subscribe

CustomFieldX = {array} (required)

Additional information about the subscriber. Replace X with the ID number of the custom field.

IPAddress = {string} (required)

IP address of subscriber

Response Parameters

Success = {true | false}

States if there is an error or not

SubscriberID = {integer}

Subscriber ID of the email address will be returned if the result is success

RedirectURL = {string}

Target URL to redirect user after the process

ErrorCode = {integer}

If there is an error, error's code

ErrorCustomFieldID = {integer}

If there's an error with one of the provided custom fields, custom field ID number will be provided

ErrorCustomFieldTitle = {integer}

If there's an error with one of the provided custom fields, custom field title will be provided

ErrorCustomFieldDescription = {integer}

If there's an error with one of the provided custom fields, description of the error message is provided

Error Codes

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

Stay connected!