Imports Citizens, Transactions, Preferences and Email Addresses.

Imports citizens with optional Transactions, Preferences and Email Addresses. Returns details about an import Job which can be used to check on the progress of the import. Upload files should be CSV files with the structure show in the example below, where the first row is column titles. Columns can appear in any order.

Example table with required columns to create a citizen, transaction and preference. The following column headers can be added which specify additional optional fields on a transaction:

emailAddress, validFrom, validUntil, obtainedAt, source, campaign, channel, sourceSystem, sourceSystemReference

uniqueReferenceprivacyPolicyIdpermissionStatementIdoptionIdoptionTypejustificationstatereferencevalues
uniqueRef-001prPol-01permStat-01opt-01groupconsentGRANTEDcontact-channels-preferencephone|post
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
length between 1 and 50

The ID associated with the target Application.

Body Params

The file to be uploaded as part of the request.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json