Sections:

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

Subscriber.OptIn

Description

Perform opt-in confirmation or reject

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {Subscriber.OptIn} (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)

Subscriber List ID

SubscriberID = {integer} (required)

Subscriber ID

Mode = {Confirm | Reject} (required)

Performs opt-in confirmation or reject

Response Parameters

Success = {true | false}

States if there is an error or not

ProcessedMode = {Confirm | Reject}

returns the process completed

RedirectURL = {string}

Target URL to redirect user after the process

ErrorCode = {integer}

If there is an error, error's code

Error Codes

1

Subscriber list ID is missing

2

Subscriber ID is missing

3

Opt mode is missing

4

Invalid subscriber list ID

5

Invalid user ID

6

Invalid subscriber ID

7

Invalid opt-in process mode

8

Subscriber already opt-in confirmed

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!