Subscriber Details (Subscriber.Get)

Description

Returns the details of a specific subscriber

Input Parameters

Command=Subscriber.Get [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. List ID numbers can be obtained from list settings page.

EmailAddress [optional]

Email address to search and retrieve.

SubscriberID [optional]

Subscriber ID to search and retrieve

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.

Subscriber [array]

An array containing the subscriber information

Error Codes

#1

List ID is missing

#2

List not found

#3

Email address does not exist in the subscriber list

#4

Subscriber ID does not exist in the subscriber list

#5

Subscriber ID or email address must be provided

#9998

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

#9999

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