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

Subscribers.Import

Description

Import the provided subscriber data into subscriber list

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 = {Subscribers.Import} (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)
Target subscriber list ID
ImportStep = {integer} (required)
1 for passing import data, 2 for field mapping
ImportID = {integer} (required)
ID number of the import process (step 2)
ImportType = {Copy | File | MySQL} (required)
Type of the import (step 1)
ImportData = {string} (required)
CSV file contents (step 1)
ImportFileName = {string} (required)
Uploaded file name (step 1)
FieldTerminator = {string} (optional, >= v4.1.0)
Set the field terminator for CSV import. Example: ,
FieldEncloser = {string} (optional, >= v4.1.0)
Set the field encloser for CSV import. Example: '
ImportMySQLHost = {string} (required)
MySQL host (step 1)
ImportMySQLPort = {string} (required)
MySQL port (step 1)
ImportMySQLUsername = {string} (required)
MySQL username (step 1)
ImportMySQLPassword = {string} (required)
MySQL password (step 1)
ImportMySQLDatabase = {string} (required)
MySQL database (step 1)
ImportMySQLQuery = {string} (required)
MySQL SQL query to execute (step 1)
AddToGlobalSuppressionList = {true | false} (required)
Defines whether import must done for global suppression list or not (step 1)
AddToSuppressionList = {true | false} (required)
Defines whether import must done for suppression list or not (step 1)
MappedFields = {string} (required)
Mapped fields (step 2)

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
ImportID = {integer}
ID number of the import data
ImportFields = {string}
List of fields included in the import data (step 1)
AllowedMaxSize = {integer}
Maximum allowed file size for import file upload. Returned if error #18 occurs (step 1)
TotalData = {integer}
Number of rows in the import data (step 2)
TotalImported = {integer}
Number of emails imported (step 2)
TotalDuplicates = {integer}
Number of emails already exists and ignored (step 2)
TotalFailed = {integer}
Number of emails failed to import (step 2)

Error Codes

1
Import type not set
2
Import data not provided
3
Import step not valid
4
Subscriber list ID is invalid
5
CSV data in not supported format
6
Import process already completed
7
Email address field mapped with multiple fields
8
Email address not mapped with any corresponding fields
9
Uploaded file is missing
10
MySQL host is missing
11
MySQL port is missing
12
MySQL database is missing
13
File does not exist
14
MySQL query is missing
15
MySQL connection or database name is incorrect. Not working.
16
MySQL query has errors
17
Import type not supported
18
Uploaded file size exceeds allowed maximum file size.
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!