Update a Dataset Schema

curl -X PATCH https://api.prolific.com/api/v1/data-collection/datasets/dataset_id \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "schema": {
    "strict": true,
    "fields": {}
  }
}'

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "Text Dataset",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "65786062db3b35bcbeb07bcc",
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "total_datapoint_count": 1,
  "schema_version": 3,
  "status": "ERROR",
  "filename": "dataset_upload_2024_01_15.csv",
  "has_predetermined_grouping_id": true,
  "schema": {
    "strict": true,
    "fields": {}
  },
  "imports": [
    {
      "dataset_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "import_id": "a12b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "type": "file_upload",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T10:00:00Z",
      "status": "partial",
      "filename": "dataset_upload_2024_01_15.csv",
      "accepted_count": 95,
      "rejected_count": 5,
      "errors": [
        {
          "record_index": 3,
          "field": "text_field",
          "reason": "Missing required text value"
        },
        {
          "record_index": 7,
          "field": "_raw",
          "reason": "Malformed JSON in record"
        }
      ],
      "reason": "Some records failed validation"
    }
  ],
  "migration_job_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Updates the schema of an existing V4 dataset. Each successful update writes a new schema version.

Schema migration. If the dataset already had a schema, changing it starts an asynchronous schema migration that re-normalises the dataset’s existing datapoints against the new version. In that case the response includes a migration_job_id; poll GET /datasets/{dataset_id}/schema-migrations/{job_id} with it until the job reaches a terminal status. When this is the dataset’s first schema, no migration is needed and migration_job_id is omitted.

Constraints:

V4 datasets only — a 400 is returned for V3 datasets.
The task_group_id column designation cannot be changed once the dataset has datapoints; attempting to do so returns 400.

Updates the schema of an existing **V4 dataset**. Each successful update writes a new schema version. **Schema migration.** If the dataset already had a schema, changing it starts an asynchronous **schema migration** that re-normalises the dataset's existing datapoints against the new version. In that case the response includes a `migration_job_id`; poll `GET /datasets/{dataset_id}/schema-migrations/{job_id}` with it until the job reaches a terminal status. When this is the dataset's **first** schema, no migration is needed and `migration_job_id` is omitted. **Constraints:** - V4 datasets only — a `400` is returned for V3 datasets. - The `task_group_id` column designation cannot be changed once the dataset has datapoints; attempting to do so returns `400`.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings. Your API token does not have an expiry date and carries full permission, so be sure to keep them secure. If your token is leaked, delete it and create a new one directly in the app. In your requests add `Authorization` header with the value `Token <your token>`.

Path parameters

dataset_idstringRequiredformat: "uuid"

The unique identifier of the V4 dataset to update

Request

This endpoint expects an object.

schemaobjectRequired

The new schema definition for the dataset.

Response

Dataset updated. Returns the updated dataset. When the update triggered a schema migration, migration_job_id is present — poll the schema-migration endpoint with it.

idstringformat: "uuid"

namestring

created_atdatetime

created_bystring

workspace_idstring

total_datapoint_countinteger>=0

schema_versionenum

Internal dataset version. 3 = legacy CSV/ZIP; 4 = structured schema with JSONL/CSV import tracking.

statusenum

Processing status. V3 datasets only. V4 datasets track status per import job via imports.

filenamestring or null

Filename of the uploaded data file. V3 datasets only.

has_predetermined_grouping_idboolean or null

Whether the dataset contains a META_TASK_GROUP_ID column. V3 datasets only.

schemaobject or null

The researcher-defined field schema for this dataset. V4 datasets only. null if no schema has been set yet.

importslist of objects or null

Import jobs for this dataset, most recent first. V4 datasets only. null for V3 datasets.

migration_job_idstringformat: "uuid"

The schema migration job started by this update. Present only when the dataset already had a schema (i.e. the schema was changed, not set for the first time). Use with GET /datasets/{dataset_id}/schema-migrations/{job_id}.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

Updates the schema of an existing V4 dataset. Each successful update writes a new schema version.

Constraints:

V4 datasets only — a 400 is returned for V3 datasets.
The task_group_id column designation cannot be changed once the dataset has datapoints; attempting to do so returns 400.