PRprolific
aiTaskBuilder

Update Batch Instructions

Changed on

Updates the instructions for a task builder batch. This is a full replacement - all instructions must be included in the request.

Include the id field for existing instructions you want to preserve. Instructions without an id will be created as new.

<Error title="Important">

Deprecated for batches that use batch_items.

If the target batch was created with batch_items (the per-item instructions flow), this endpoint will respond with 422 Unprocessable Entity and an error message directing you to manage instructions via the batch_items payload instead.

The response will also include the RFC 8594 headers Deprecation: true and Sunset: Tue, 01 Sep 2026 23:59:59 GMT. Legacy batches (where batch_items is null) are unaffected and continue to work as before.

</Error>
put/api/v1/data-collection/batches/{batch_id}/instructions

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/batches/{batch_id}/instructions
  • Auth
    API key in header Authorization

Path parameters

batch_idstring required

Batch ID

Request body

Response

Updated. Returned only for legacy batches (batch_items is null).

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id update-task-builder-instructions removed and replaced with aiTaskBuilder_UpdateTaskBuilderInstructions