Import data through a pipeline

Run a data import using the specified pipeline configuration.

Triggers a data pipeline import. Accepts a file or raw JSON text, or uses the stored sample file if no input is provided.

Body Params
uuid
required

UUID of the data pipeline to execute.

file

File (CSV or JSON) to import.

string

Raw JSON text to import.

string

S3 key of the file to import (one-time import flow).

string
enum

Format of the file or s3Key, when it differs from the pipeline's: any pipeline imports a CSV or a JSON file. Defaults to the pipeline's format.

Allowed:
string

JSON array of S3 keys to delete when import reaches a terminal state. Backend performs cleanup; do not call cleanupTempFiles from the client.

boolean

Required true for prospects-type pipelines: confirms the uploader holds consent or another lawful basis to contact the individuals in the file. Ignored for other data types.

uuid

Option Bank pipelines with no target of their own (the standard one): the existing Option Bank to fill. Ignored when the pipeline names its own target.

string
^[,;|\t]$
string

Option Bank pipelines with no target of their own: the name of a new Option Bank to create and fill, used when optionBankDatasetUuid is absent.

uuid

Dataset pipelines: an existing dataset of the company, Option Banks included, to fill in place of the pipeline's own target.

string

Dataset pipelines: the name of a new dataset to create, with the pipeline's key column, and fill. Used when datasetUuid is absent.

Responses

400

Bad request - missing dataPipelineUuid, no input data provided, or (prospects-type pipelines) consent not confirmed

404

Data pipeline not found

500

Internal server error

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