MPZ API > Query Bulk Imports

Use this API to query the status and results of bulk add subscribers jobs.

If a bulk add job is still in progress, you will simply receive statistics such as total subscribers, total imported, total failed, etc. If the job has finished, you will also receive detail of the email address that did not import because they were invalid, already unsubscribed, already existed in the group, etc.

Request

Submit an XML Request with the following details:
Post URL: https://mpzmail.com/api/v3.0/subscribers/bulkQuery/
Fields to Post
apiKey String REQUIRED The APIKey of the requesting user.
importID Int REQUIRED The import ID that you would like to query.

Response

Data Sent Back
error Int Indicates wether an error has occured. 0 for no error. 1 for error.
status String If there's been an error, a text description of the error that occured will be here.
job    
---> jobStatus Int The status of the job. Statuses returned are as follows:

0 = Queued for start
1 = In Progress
2 = Finished
3 = Finished (And user has seen the results in the control panel)
---> totSubs Int The total number of subscribers detected in the import file.
---> totDone Int The number of subscribers processed so far.
---> totInvalid Int The number of invalid email addresses. ie the email was misformed, blank, etc.
---> totDupes Int The number of duplicate email addresses found either in the upload, or already existing in the group.
---> totUnsubscribed Int The number of previously unsubscribed email addresses found in the upload.
---> dupeData String Only available once job complete. A list of email addresses, delimited by // that have been found as duplicated either in the upload or in the group.
---> invalidData String Only available once job complete. A list of email addresses, delimited by // that have were invalid.
---> unsubData String Only available once job complete. A complete list of email addresses, delimited by // that have been found as previously unsubscribed.

Sample request XML

<xml>
     <apiKey>44-121312131223</apiKey>
     <importID>213213</importID>
</xml>

Sample response XML

<xml>
     <error>0</error>
     <status>success</status>
     <job>
          <jobStatus>2</jobStatus>
          <totSubs>2</totSubs>
          <totDone>2</totDone>
          <totInvalid>1</totInvalid>
          <totDupes>0</totDupes>
          <totUnsubscribed>1</totUnsubscribed>
          <dupeData>test@test.com</dupeData>
          <invalidData></invalidData>
          <unsubData>unsubscriber@test.com</unsubData>
     </job>
</xml>

Comments