Skip to main content
POST
Import a CSV file as new rows in batches (dry-run unless --execute)

Body

application/json
base
string
required

Base id or slug

file
string
required

CSV file with a header row

batch
string

Rows per request, 1-500 (default 500)

console
string

Console base URL

execute
boolean

Actually create the rows; default is a dry-run preview of the mapping (exit 3)

map
string[]

Map a CSV column to a property key ("Deal Name=name"); "column=-" skips it. Repeatable

project
string

Console project id or slug; overrides the saved Console scope

Response

Success — body conforms to the @Returns schema.

baseRef
string
required
batchCount
number
required
batches
object[]
required
columns
object[]
required
consoleUrl
string
required
created
number
required
emptyRowsSkipped
number
required
file
string
required
projectRef
string
required
rowCount
number
required
success
boolean
required