API Reference
Log In
API Reference

Execute data pipeline import

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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

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.

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
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json