Subscription (Subscriber.Subscribe)

Description

This command will allow you to subscribe new email addresses to target subscriber list. Addition to the email address, additional information (custom field) can be added to the subscriber record as well.

Input Parameters

Command=Subscriber.Subscribe [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 subscribed

SubscriptionIP [required]

IP address of the subscriber

Fields [optional]

Custom field information for the email address. This information will be provided as array such as Fields[CustomField4], Fields[CustomField5], etc.

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.

SubscriberID [integer]

ID number of the new subscriber

SubscriptionStatus [string]

'Confirmation Pending' or 'Subscribed', if list subscription type is "Double Opt-In&quo;, the returned value will be confirmation pending

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

Subscription IP address is missing

#5

Invalid email address format

#6

Email address already exists in the target list

#7

Invalid email address

#9998

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

#9999

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