# Match and import to list

Import records into a given list and match them. The request body is a JSON array of items to be imported for matching.
First you'll need to use [Create a List](#operation/POST/lists) to create a list.  Make sure to set:
ImportSource=api
ListType=import

Endpoint: POST /v1/lists/{ListID}/import/items
Version: 5.3.0.0
Security: api_key_bearer, x_radar_access_token

## Security:

  - `api_key_bearer` (unknown)
    http bearer

  - `x_radar_access_token` (unknown)
    apiKey in header X-Radar-Access-Token

## Path parameters:

  - `ListID` (integer, required)
    Unique identifier for the list.

## Query parameters:

  - `Fields` (array)
    A list of fields or fieldsets the client would like returned from the service.  Fields can be suppressed by prepending "-"

  - `Purchase` (integer, required)
    Calls to this endpoint are charged per record returned.  To get a preview of the cost, set Purchase=0.  If Purchase is set to '1' or 'true', you will be charged against your balance for each record returned according to the terms of your subscription package. Charges are non-refundable.

## Request fields (application/json):

  - `FirstName` (string)
    Imported Owner First Name.
    Example: John

  - `LastName` (string)
    Imported Owner Last Name.
    Example: Doe

  - `FullName` (string)
    Imported Owner Full Name.
    Example: John Doe

  - `Email` (string)
    Imported Email Address.
    Example: email@example.com

  - `EmailStatus` (string)
    Imported Email Status.

  - `Phone` (string)
    Imported Phone Number.
    Example: 555-555-1234

  - `PhoneType` (string)
    Imported Phone Type.

  - `PhoneStatus` (string)
    Imported Phone Status.

  - `Address` (string)
    Imported Address.
    Example: 120 SE Main St #500

  - `City` (string)
    Imported City.
    Example: ANAHEIM

  - `State` (string)
    Imported State.
    Example: CA

  - `ZipFive` (string)
    Imported Zip Code.
    Example: 95555

  - `County` (string)
    Imported County.
    Example: ORANGE

  - `APN` (string)
    Imported APN.
    Example: 13-08-180-021

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `results` (array)

  - `results.ListImportItemID` (integer)
    Unique identifier for the import list item.
    Example: 123456

  - `totalCost` (string)
    The total amount billed for the records in this response
    Example: 1.00

  - `quantityFreeRemaining` (integer)
    Export credits remaining in the account. Only present for preview (Purchase=false) responses.
    Example: 250

  - `resultCount` (integer)
    The number of records in this response
    Example: 20

## Response 400:

  - `400` (unknown)
    Bad request

## Response 400 fields (application/json):

  - `error` (string)
    A simple explanation of the problem.  Not for display to end users.

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users

## Response 402:

  - `402` (unknown)
    Insufficient Balance. Returned when the account balance is too low to cover the cost of the purchase this request would incur (i.e. when the request charges for records and `Purchase=1`). Add to your balance to retry; an unpaid cost quote can be obtained with `Purchase=0`.

## Response 402 fields (application/json):

  - `error` (string)
    A simple explanation of the problem.  Not for display to end users.
    Example: Insufficient Balance

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    An explanation suitable for display to end users
    Example: Your account balance is insufficient to process this request. Log in at app.propertyradar.com to Add to Balance, and consider changing your Low Balance Notification and Auto Recharge settings

  - `messageTitle` (string)
    A title suitable for display to end users
    Example: Sorry, Insufficient Balance

## Response 403:

  - `403` (unknown)
    Forbidden. Returned when the access token is valid but the request is denied for authorization reasons. Common cases include an inactive subscription, a missing API or Integrations entitlement, insufficient OAuth scope, or lacking permission for the requested operation. Invalid or expired tokens return 401 instead.

## Response 403 fields (application/json):

  - `error` (string)
    A simple explanation of the problem. Not for display to end users. OAuth denials often use the form `{error_code} - {description}` (for example, `access_denied - ...`). Permission denials typically return `You are not authorized to use this service.`
    Example: You are not authorized to use this service.

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users

## Response 404:

  - `404` (unknown)
    Not found. Returned when the requested path is unknown, authentication is missing (some routes return 404 rather than 401 to avoid revealing route existence), or a path parameter identifies a resource that does not exist or is not visible to the authenticated account (for example, an invalid RadarID or an ID belonging to another account). This replaces the previous behavior of returning 400 for resource-not-found errors.

## Response 404 fields (application/json):

  - `error` (string)
    A simple explanation of the problem. Not for display to end users. Resource-not-found errors typically return `Resource does not exist for given id`. Unknown paths or missing authentication may return a message indicating the path was not found or authentication is missing.
    Example: Resource does not exist for given id

  - `eventid` (string)
    A code in the form xxx-xxx-xxx that can be used for troubleshooting. Also present in headers as X-Radar-Request-Id
    Example: abc-123-def

  - `message` (string)
    If present, an explanation suitable for display to end users

  - `messageTitle` (string)
    If present, a title suitable for display to end users