Update a Batch | Prolific API

import requests
url = "https://api.prolific.com/api/v1/data-collection/batches/batch_id"
payload = {}
headers = {
    "Authorization": "Token <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "b3f1c9d2-8a4e-4f7a-9c3d-2e5f7a1b9c4d",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "6278cb09062dbb35bc4abebc",
  "datasets": [
    {
      "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
      "total_datapoint_count": 1500,
      "filename": "customer_feedback_2024.csv"
    }
  ],
  "name": "Customer Feedback Analysis Batch",
  "status": "UNINITIALISED",
  "total_task_count": 25,
  "total_instruction_count": 10,
  "workspace_id": "6278acb09062db3b35bcbeb0",
  "schema_version": 1,
  "task_details": {
    "task_name": "Sentiment Classification",
    "task_introduction": "Classify customer feedback into positive, neutral, or negative sentiments.",
    "task_steps": "1. Read the feedback text. 2. Determine the sentiment category. 3. Submit the classification."
  },
  "total_task_groups": 3
}

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

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

batch_idstringRequired

The unique identifier of the batch

Request

This endpoint expects an object.

namestringOptional

task_detailsobjectOptional

dataset_idstringOptionalformat: "uuid"

Response

idstringformat: "uuid"

created_atdatetime

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

created_bystring

User ID of the Prolific user that created the resource.

datasetslist of objects

namestring

statusenum

Allowed values:

total_task_countinteger>=0

total_instruction_countinteger>=0

workspace_idstring

schema_versioninteger

task_detailsobject

total_task_groupsinteger>=0

Authentication

Path parameters

Request

Response

Errors