Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.
Sections:
- Description
- Oempro Version
- Request Parameters
- Response Parameters
- Error Codes
Subscriber.Get
Description
Retrieve subscriber information
Oempro Version
4.1.15+
Request Parameters
- SessionID = {string} (required)
- Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
- Command = {Subscribers.Get} (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
- EmailAddress = {string} (required)
- Email address of the target subscriber
- ListID = {integer} (required)
- ID of the list which email address is subscribed to
Response Parameters
- Success = {true | false}
- States if there is an error or not
- ErrorCode = {integer}
- If there is an error, error's code
- ErrorText = {text}
-
- SubscriberInformation = {array}
- Returns the subscriber information
Error Codes
- 1
- Missing email address
- 2
- Missing subscriber list ID
- 3
- Subscriber doesn't exist
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
Stay connected!
