List Configured Products

Useful as a reference to query what preconfigured products are available for your account to perform API based file batch append with. Provides the name and the field mappings required to use the Submit File endpoint.

πŸ“˜

Note

This set of products is the same as available on the client portal when uploading files via our website.
You account may not have any preconfigured products. If you need to have new products created or update
existing ones please contact support.

GET Management/V1/Queue/ListConfiguredProducts

Authentication
Authentication to this endpoint is performed by supplying your api key value in the "Authorization" HTTP header of the request.

Response (Success) HTTP 200

{
  "Products": [
    {
      "Name": "Product Name",
      "RequiredMapping": [
        "FirstName",
        "LastName",
        "StreetAddress",
        "City",
        "State",
        "PostalCode"
      ]
    }
  ]
}

Understanding the Products payload

note: The documentation describes the individual configured product information elements.

ElementDescription
NameThe name of your pre-configured product. This is the value used with the "product_name" parameter of the Submit File endpoint.
RequiredMappingThe set of fields that are required to be mapped to your file to use this product. This is the value used with the "column_map" parameter of the Submit File endpoint.

Copyright (c) 2015-2024, Accurate Append Corp
All rights reserved.