[HTTP POST] ~/contactLists/{contactListId}/import/{importJobId}

Description: Insert/Update a batch of Contacts in a specific Import Job belonging to a specific Contact List

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactListId

ContactList ID

 integer

Required
importJobId

ImportJob ID

 integer

Required

Body Parameters

[In Request Body] an Array of Contacts for Create/Update - the service will accept up to 10,000 contacts in a single request.

Collection of Contact
NameDescriptionTypeAdditional information
EncContactId

string

None.
ListId

integer

None.
Values

Dictionary of string [key] and Object [value]

None.

Formats

application/json, text/json

Sample: 
[
  {
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  {
    "EncContactId": "sample string 2",
    "ListId": 3,
    "Values": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
]

application/csp-report

Sample: 
[{"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}},{"EncContactId":"sample string 2","ListId":3,"Values":{"sample string 1":{},"sample string 3":{}}}]

application/xml, text/xml

Sample: 
<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO">
  <Contact>
    <EncContactId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">sample string 2</EncContactId>
    <Id xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">1</Id>
    <ListId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">3</ListId>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
  <Contact>
    <EncContactId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">sample string 2</EncContactId>
    <Id xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">1</Id>
    <ListId xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">3</ListId>
    <Values xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/W50Common.Model.DTO">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Values>
  </Contact>
</ArrayOfContact>

Response Information

Description

Successful Response - OK (200):

Response Content : ImportJob

NameDescriptionTypeAdditional 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 Contacts were inserted into the ImportJob successfully.
  • 400 - BadRequest
    • Attempted to insert an incorrect number of contacts - only 1-1000 contacts allowed per call.
  • 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

Sample: 
{
  "Id": 1,
  "ContactListId": 1,
  "InvalidEmailCount": 1,
  "InvalidSmsCount": 1,
  "ProgressPercent": 1,
  "CurrentStatus": "sample string 2",
  "StartDate": "2024-12-27T18:19:43.7036074+00:00",
  "FinishDate": "2024-12-27T18:19:43.7036074+00:00",
  "InsertedContacts": 1,
  "UpdatedContacts": 1,
  "DroppedContacts": 1,
  "NotUpdatedContacts": 1,
  "TotalContacts": 1
}

application/csp-report

Sample: 
{"Id":1,"ContactListId":1,"InvalidEmailCount":1,"InvalidSmsCount":1,"ProgressPercent":1,"CurrentStatus":"sample string 2","StartDate":"2024-12-27T18:19:43.7036074+00:00","FinishDate":"2024-12-27T18:19:43.7036074+00:00","InsertedContacts":1,"UpdatedContacts":1,"DroppedContacts":1,"NotUpdatedContacts":1,"TotalContacts":1}

application/xml, text/xml

Sample: 
<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-12-27T18:19:43.7036074+00:00</FinishDate>
  <Id>1</Id>
  <InsertedContacts>1</InsertedContacts>
  <InvalidEmailCount>1</InvalidEmailCount>
  <InvalidSmsCount>1</InvalidSmsCount>
  <NotUpdatedContacts>1</NotUpdatedContacts>
  <ProgressPercent>1</ProgressPercent>
  <StartDate>2024-12-27T18:19:43.7036074+00:00</StartDate>
  <TotalContacts>1</TotalContacts>
  <UpdatedContacts>1</UpdatedContacts>
</ImportJob>