[HTTP GET] ~/contactLists/{contactListId}/import/{importJobId}
Description: Check the status of an Import Job belonging to a specific ContactList
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactListId | integer |
Required |
|
| importJobId | integer |
Required |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
Response Content : ImportJob
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The Id of the ImportJob |
integer |
None. |
| ContactListId |
The ContactList this ImportJob is attached to |
integer |
None. |
| InvalidEmailCount |
The number of Invalid Emails Addresses found by this Import Job |
integer |
None. |
| InvalidSmsCount |
The number of Invalid TextMessage Numbers found by this ImportJob |
integer |
None. |
| ProgressPercent |
The completion percent of this Import Job |
integer |
None. |
| CurrentStatus |
The current status of this Import Job |
string |
None. |
| StartDate |
When this ImportJob Started |
date |
None. |
| FinishDate |
When this ImportJob finished |
date |
None. |
| InsertedContacts |
How many new contacts were created as part of the ImportJob |
integer |
None. |
| UpdatedContacts |
How many existing contacts were updated as part of the ImportJob |
integer |
None. |
| DroppedContacts |
How many existing contacts were deleted as part of the ImportJob |
integer |
None. |
| NotUpdatedContacts |
How many existing contacts where NOT updated as part of the ImportJob |
integer |
None. |
| TotalContacts |
The Total number of contacts Inserted/Updated as part of this ImportJob |
integer |
None. |
Response Codes:
-
200 - OK
- The Import Job was retrieved and returned successfully
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user does not have the relevant permissions to perform this action.
-
404 - NotFound
- The specified Contactlist or ImportJob were not found.
-
500 - InternalServerError
- An error occurred while processing this request.
Formats
application/json, text/json
{
"Id": 1,
"ContactListId": 1,
"InvalidEmailCount": 1,
"InvalidSmsCount": 1,
"ProgressPercent": 1,
"CurrentStatus": "sample string 2",
"StartDate": "2024-05-05T22:03:08.8269906+01:00",
"FinishDate": "2024-05-05T22:03:08.8269906+01:00",
"InsertedContacts": 1,
"UpdatedContacts": 1,
"DroppedContacts": 1,
"NotUpdatedContacts": 1,
"TotalContacts": 1
}
application/csp-report
{"Id":1,"ContactListId":1,"InvalidEmailCount":1,"InvalidSmsCount":1,"ProgressPercent":1,"CurrentStatus":"sample string 2","StartDate":"2024-05-05T22:03:08.8269906+01:00","FinishDate":"2024-05-05T22:03:08.8269906+01:00","InsertedContacts":1,"UpdatedContacts":1,"DroppedContacts":1,"NotUpdatedContacts":1,"TotalContacts":1}
application/xml, text/xml
<ImportJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO"> <ContactListId>1</ContactListId> <CurrentStatus>sample string 2</CurrentStatus> <DroppedContacts>1</DroppedContacts> <FinishDate>2024-05-05T22:03:08.8269906+01:00</FinishDate> <Id>1</Id> <InsertedContacts>1</InsertedContacts> <InvalidEmailCount>1</InvalidEmailCount> <InvalidSmsCount>1</InvalidSmsCount> <NotUpdatedContacts>1</NotUpdatedContacts> <ProgressPercent>1</ProgressPercent> <StartDate>2024-05-05T22:03:08.8269906+01:00</StartDate> <TotalContacts>1</TotalContacts> <UpdatedContacts>1</UpdatedContacts> </ImportJob>