Imports

Imports Overview

The Imports API is an adapter API for batches API and allows you to perform bulk operations on various resources such as contacts and groups via a Semantic csv upload.

# Imports Actions

• merge: Updates and/or creates the items in the csv.
• overwrite: Creates and/or updates items in the csv, and deletes all other items.
• delete: Deletes all the items in the csv. A valid id is required for each item.

# Imports Resources

Currently, the following resources are supported:

• contact: All actions applicable.
• group: All actions applicable.

# Imports Phases

Each Import can have 3 of it's own phases, phases of batches begin after completion of imports phases

• prevalidation: Parses the CSV file.
• preparsing: Removes duplicates.
• transforming: Transforms the data to a batch digestible format.

# Imports Modes

• sync: All phases are synchronous. The import is immediately processed with some restrictions.
• mixed: All import phases are synchronous and from batches phases parsing and validation phases are synchronous; processing and cleanup are asynchronous. This is the default mode.

# Imports Statuses

# Initial/Intermediate Statuses

• queued: Import is valid and is in queue to be processed.
• processing: Writes/deletes/overwrites are being processed.

# Final Statuses

• completed: Processing complete.
• failed: Unable to start or complete processing.
• timed_out: Import took too long to process.

# Stats

• How many resources were created, updated, and/or deleted in this import.
• For the overwrite action, the number of resources removed as overwritten.

# Other Properties

• reason: Reason for a final status other than completed.
• has_upload_file: Indicates if the original payload can be downloaded.
• has_errors_file: Indicates if error rows/items can be downloaded.
• _upload_url: URL for uploading a file/payload via a signed URL.
• _upload_csv_url: URL to download the original payload as a CSV file.
• _upload_json_url: URL to download the original payload as a JSON file.
• _errors_csv_url: URL to download errors as a CSV file.
• _errors_json_url: URL to download errors as a JSON file.