Skip to main content
POST
Preview parsed records

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

listId
string
required

The custom list id.

Body

application/json

Rows already parsed by the client. The camelCase spellings mergeMode, recordIdColumn and parsedRecords are also accepted.

merge_mode
enum<string>
required

upsert_only adds and updates; full_replace also archives records missing from the upload; validate_only checks without staging changes.

Available options:
upsert_only,
full_replace,
validate_only
record_id_column
string
required
parsed_records
object[]
required

Response

Accepted; the preview is queued.

{ data: CustomListUploadJob }

data
object
required