Skip to main content
POST
Upload a file

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

multipart/form-data

Multipart form with exactly three fields: file (a CSV or XLSX file within the tenant upload limit), merge_mode (upsert_only, full_replace or validate_only) and record_id_column (the column holding each record id). Any other field is 400.

Multipart form. Only these three fields are accepted; any other field is 400.

file
file
required

A CSV or XLSX file within the tenant upload limit.

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

Response

Accepted; validation is queued.

{ data: CustomListUploadJob }

data
object
required