Import

The MyPreferences Import Bulk API is designed to simplify and accelerate how you bring data into your MyPreferences account. These APIs are purpose-built to automate large-scale imports with ease, helping you to automate and streamline data import processes. It also enables you to establish periodical imports to sync MyPreferences with customer data captured in other applications.

Workflow

Initiate: Request to initiate an import

Stage: Stage data that you want to import using the access token. Depending on the size of your request, you may make multiple requests to stage your entire dataset to import

Execute: Once all the data is staged, request to execute the import

Status: Check the status of your import by polling the Status endpoint using the status token

Retrieve (optional): Retrieve any validation failures and exceptions using the Exceptions endpoint.

Rate Limiting & Usage Guidelines

To ensure stable and efficient use of our API, we enforce a 24-hour rate limiting policy on import requests. Each account has a maximum daily import request limit, which is tracked over a rolling 24-hour period.

Per-request data size: The default maximum payload size for a POST request (used to stage data) is 25 MB. The maximum allowed is 28 MB per request.

Total staged data per import: A single bulk import operation can stage up to approximately 10 million records.

Distribute requests evenly: We recommend spreading import jobs evenly throughout the day to stay within your allotted daily limit. .

Optimize request size: If your data volume increases, consider sending more data per import to make the most of your quota. The total count of staged data can be up to ~ 10 million records in a single bulk import operation (i.e., per access token).

Sequential imports: Once an import is executed, you can immediately commence a subsequent import operation without having to space them.

Avoid parallel processing: We recommend processing one import job at a time. Running imports in parallel increases the risk of hitting rate limits and may lead to data conflicts.

Handling limit exceedance: If you exceed your 24-hour limit, do not retry immediately. Instead, log the failure and queue the data for retry in the next available batch window.