Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
aiTaskBuilder

Update a Batch

Update an existing AI Task Builder batch. You can update the name, task details, associated dataset, and/or batch_items. The dataset does not need to be in READY status for updates.

When updating batch_items, include the id of any existing pages, rows, columns, or items you want to preserve — items without an id are treated as new and assigned one server-side. Omitting an existing id removes that entry. The same validation rules as on create apply, and validation failures return 422 Unprocessable Entity with the BatchItemsValidationError payload.

patch/api/v1/data-collection/batches/{batch_id}

Path parameters

batch_idstring required

The unique identifier of the batch

Headers

Authorizationstring required

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>.

Request body

namestring
dataset_idstring uuid
auto_sync_enabledboolean

When true, datapoints subsequently appended to the batch's attached dataset (via POST /datasets/{dataset_id}/datapoints) automatically trigger a sync that materialises tasks for them — no explicit POST /batches/{batch_id}/sync call is needed. When false, appended datapoints are only picked up by an explicit sync. If this field is omitted from the PATCH payload, the existing auto-sync setting is left unchanged.

Response

Ok

idstring uuid required
created_atstring date-time required

An ISO-8601 formatted string representing the batch creation time, in UTC.

created_bystring required

User ID of the Prolific user that created the resource.

namestring required
status'UNINITIALISED' | 'PROCESSING' | 'READY' | 'ERROR' required
total_task_countinteger required
total_instruction_countinteger required
workspace_idstring required
schema_versioninteger required
total_task_groupsinteger required
auto_sync_enabledboolean

When true, datapoints appended to the batch's attached dataset automatically trigger a sync that materialises tasks for them. Optional — absent on batches that have never enabled auto-sync. Absent or false mean auto-sync is off.