POST {version}/ImportQueue

Inserts a record into the Import Queue. Expects an object in the request body which consists of an ImportQueueRecord and an optional list of CodeNames.

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

ImportQueueRecordWithCodes

Name	Description	Type	Additional information
ImportQueueRecord		ImportQueueRecord	None.
CodeNames		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "ImportQueueRecord": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Title": "sample string 3",
    "Suffix": "sample string 4",
    "HomeLine1": "sample string 5",
    "HomeLine2": "sample string 6",
    "HomeCity": "sample string 7",
    "HomeState": "sample string 8",
    "HomeZip": "sample string 9",
    "HomePhone": "555-555-5555",
    "WorkPhone": "555-555-5555",
    "PersonalEmail": "[email protected]",
    "WorkEmail": "[email protected]",
    "DOB": "04/03/2025",
    "Employer": "sample string 10",
    "Occupation": "sample string 11",
    "CCAmount": 1.0,
    "WorkCity": "sample string 12",
    "WorkState": "sample string 13",
    "SourceCode": "sample string 14",
    "CreatedOn": "04/03/2025",
    "CCResponse": "sample string 15",
    "ParentRecurId": "sample string 16",
    "ImportSetting": "sample string 17",
    "TransactionId": "sample string 18"
  },
  "CodeNames": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ImportQueueRecordWithCodes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.CM.Model">
  <CodeNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CodeNames>
  <ImportQueueRecord>
    <CCAmount>1</CCAmount>
    <CCResponse>sample string 15</CCResponse>
    <CreatedOn>2025-04-03T04:43:13.0805776-04:00</CreatedOn>
    <DOB>2025-04-03T04:43:13.0805776-04:00</DOB>
    <Employer>sample string 10</Employer>
    <FirstName>sample string 1</FirstName>
    <HomeCity>sample string 7</HomeCity>
    <HomeLine1>sample string 5</HomeLine1>
    <HomeLine2>sample string 6</HomeLine2>
    <HomePhone>555-555-5555</HomePhone>
    <HomeState>sample string 8</HomeState>
    <HomeZip>sample string 9</HomeZip>
    <ImportSetting>sample string 17</ImportSetting>
    <LastName>sample string 2</LastName>
    <Occupation>sample string 11</Occupation>
    <ParentRecurId>sample string 16</ParentRecurId>
    <PersonalEmail>[email protected]</PersonalEmail>
    <SourceCode>sample string 14</SourceCode>
    <Suffix>sample string 4</Suffix>
    <Title>sample string 3</Title>
    <TransactionId>sample string 18</TransactionId>
    <WorkCity>sample string 12</WorkCity>
    <WorkEmail>[email protected]</WorkEmail>
    <WorkPhone>555-555-5555</WorkPhone>
    <WorkState>sample string 13</WorkState>
  </ImportQueueRecord>
</ImportQueueRecordWithCodes>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

No return value

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.