Data Sets

Import data set records

Imports data set records from an external source via CSV upload.

The data set must already exist and must not contain any duplicate column names.

post/data-sets/{dataSetId}/records/import

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/data-sets/{dataSetId}/records/import
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

dataSetIdstring required

The ID of the Data Set

Request body multipart/form-data

strategy'Append' | 'Upsert' | 'Sync' required

How rows in the uploaded CSV are reconciled with the existing data set.

  • Append — every uploaded row is inserted as a new row (no key required; nothing is updated or deleted).
  • Upsert — rows whose key column matches an existing row are updated in place; new keys are inserted; rows absent from the upload are left untouched.
  • Sync — like Upsert, but rows in the data set whose key is absent from the upload are deleted, leaving the data set fully in sync with the file.
filestring binary required

Uploaded file reference. Use the upload endpoint to attach content.

keystring

Unique key used to identify this row across imports — matches the data set column referenced by the webhook's keyColumn.

Response

idstring required

The ID of the Data Set

createdinteger required
updatedinteger required
deletedinteger required

Example response

{
  "id": "qjtpdD0M7Q0BoZxtgH5wiA"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.