Skip to content

Import Service

The import service is designed to handle large sets of data using pre-formatted standardised file formats. It allows two primary types of imports to be carried out:

  • Importing supporter data: This relies on using a previously saved format, which has been created and named using the standard manual user data import process in your account dashboard. The format includes which fields and in what order they should be imported into the account. Like with regular dashboard, it is also possible to map campaign participations, Opt-in responses etc. to objects in the account, however the participation date and time for these entries will be fixed to the time of the import.

  • Importing transactional data: Transactional data can be bulk imported using a fixed format named importTransactions. This allows for the campaign date and time to be specified, so can be beneficial when importing historical records. When preparing files for import, please note that all the transaction described in single file must relate to the same 'campaign id'.

The specific formatting rules for different types of campaigns that are possible to import are laid out in more detail in the importTransactions format (described here).

Rolling back transactions

Note: The rollback function is not available for fundraising transactions imported via this service. If you think you may require rollback, please use the dashboard 'Import finance transactions' feature instead.

After successfully posting a file for import into the service, the job will be submitted to the system and will then be processed as soon as possible. Notification recipients will receive any updates via email regarding the status of the job.

Importing Opt-in responses#

Opt-in responses can be imported as part of a supporter data file, or as transactional import of QCB transactions.

Note that Opt-in responses imported via this service will not be made available again through the export service, as this would have the potential to cause feedback loops. The dashboard tools for supporter management and data export will include all responses regardless of their origin.

Use of CRM segments#

When importing supporter data, the supporters in a particular batch can be associated with an external CRM by submitting the parameters segmentId and segmentName as part of the request.

The values of these parameters should be the desired identifier and reference name of the CRM segment, respectively. If segmentName is left blank, the reference name of the created segment will be the same as the identifier.

The CRM segments created in the account can be viewed under Data & Reports → External CRM Segments, and can be used within the query builder to select the included supporters.

Reference Materials#

  • The full list of available calls and their parameters are described here
  • A description of the import format used for transactions importTransactions.