Subscriber.OptIn

Description

Perform opt-in confirmation or reject

Request Parameters

APIKey = {string} (required)
The API key you are using to authenticate the access.
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
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Subscriber.Login

Description Logs in the subscriber Request Parameters Command = {Subscriber.Login}...

Subscriber.GetLists

Description Returns subscriber lists of the user '''Important:''' This command requires...

Subscriber.Get

Description Retrieve subscriber information Request Parameters APIKey = {string} (required)...

Subscribers.Get

Description Retrieves subscribers of a subscriber list. Request Parameters APIKey = {string}...

Subscribers.Import

Description Import the provided subscriber data into subscriber list Request Parameters...