Support and Documentation


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:

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

AutoResponder.Create

Description

Creates a new auto responder for given subscriber list.

Oempro Version

Oempro v4.0 and higher versions

Request Parameters

SessionID = {string} (required)
Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command = {Admin.Update} (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
SubscriberListID = {integer} (required)
ID of the subscriber list that auto responder will be created for.
EmailID = {integer} (required)
Email ID
AutoResponderName = {string} (required)
Name of auto responder.
AutoResponderTriggerType = {OnSubscription | OnSubscriberLinkClick | OnSubscriberForwardToFriend} (required)
Type of auto responder trigger.
AutoResponderTriggerValue = {string} (required)
Value of auto responder trigger.
TriggerTimeType = {Immediateky | Seconds later | Minutes later | Hours later | Days later | Weeks later | Months later} (required)
Trigger time type.
TriggerTime = {integer} (required)
Trigger time.

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
AutoResponderID = {integer}
ID of the new auto responder

Error Codes

1
Subscriber list id is missing
2
Auto responder name is missing
3
Auto responder trigger type is missing
4
Auto responder trigger value is missing
5
Auto responder trigger time is missing
6
Auto responder trigger type is invalid
7
Auto responder trigger time type is invalid
8
Missing email ID
9
Invalid email ID
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!