Update a Collection

PUT

https://api.prolific.com/api/v1/data-collection/collections/:collection_id

PUT

/api/v1/data-collection/collections/:collection_id

curl -X PUT https://api.prolific.com/api/v1/data-collection/collections/collection_id \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Updated Skin Type Assessment",
  "task_details": {
    "task_name": "Assess Your Skin Type",
    "task_introduction": "<p>Please answer the following questions about your skin.</p>",
    "task_steps": "<ol><li>Read each question carefully</li><li>Select the most accurate answer</li></ol>"
  },
  "collection_items": [
    {
      "page_items": [
        {
          "id": "01924850-9e29-744a-811c-b26612812346",
          "type": "rich_text",
          "content": "## Section 1: Basic Information"
        },
        {
          "id": "01924850-9e29-744a-811c-b26612812347",
          "type": "multiple_choice",
          "content": "What is your skin type?"
        }
      ],
      "id": "01924850-9e29-744a-811c-b26612812345"
    }
  ]
}'

{
  "id": "a3f1c2d4-5678-4e9b-9f12-3456789abcde",
  "schema_version": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "user_12345",
  "workspace_id": "workspace_67890",
  "name": "Updated Skin Type Assessment",
  "task_details": {
    "task_name": "Assess Your Skin Type",
    "task_introduction": "<p>Please answer the following questions about your skin.</p>",
    "task_steps": "<ol><li>Read each question carefully</li><li>Select the most accurate answer</li></ol>"
  },
  "collection_items": [
    {
      "id": "01924850-9e29-744a-811c-b26612812345",
      "created_at": "2024-01-10T08:00:00Z",
      "created_by": "user_12345",
      "schema_version": 1,
      "page_items": [
        {
          "type": "multiple_choice",
          "answer_limit": 1,
          "created_at": "2024-01-10T08:05:00Z",
          "created_by": "user_12345",
          "description": "What is your skin type?",
          "id": "01924850-9e29-744a-811c-b26612812347",
          "options": [
            {
              "label": "Oily",
              "value": "oily",
              "exclusive": false
            },
            {
              "label": "Dry",
              "value": "dry",
              "exclusive": false
            },
            {
              "label": "Combination",
              "value": "combination",
              "exclusive": false
            },
            {
              "label": "Normal",
              "value": "normal",
              "exclusive": false
            }
          ],
          "order": 1,
          "parent_id": "01924850-9e29-744a-811c-b26612812345",
          "parent_type": "collection",
          "disable_dropdown": false,
          "helper_text": "Choose the option that best describes your skin.",
          "placeholder_text_input": "Select one"
        },
        {
          "type": "rich_text",
          "created_at": "2024-01-10T08:02:00Z",
          "created_by": "user_12345",
          "id": "01924850-9e29-744a-811c-b26612812346",
          "parent_id": "01924850-9e29-744a-811c-b26612812345",
          "parent_type": "collection",
          "description": "Section header",
          "order": 0,
          "helper_text": "",
          "placeholder_text_input": "",
          "answer_limit": 0,
          "disable_dropdown": false,
          "options": []
        }
      ]
    }
  ],
  "last_modified_at": "2024-01-15T09:30:00Z",
  "last_modified_by": "user_12345"
}

Update an existing AI Task Builder Collection. This is a full replacement — all fields must be provided.

To preserve existing entities (collection items, page items) when updating, include their id fields in the request. Entities without IDs will be created as new, and existing entities not included in the request will be deleted.

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

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.

namestringRequired

The name of the collection

task_detailsobjectRequired

Task metadata displayed to participants

collection_itemslist of objectsRequired

Pages within the collection. Include id to preserve existing items.

Response

idstringformat: "uuid"

schema_versionenum

Allowed values:

created_atdatetime

ISO-8601 formatted creation timestamp in UTC

created_bystring

User ID of the Prolific user that created the collection

workspace_idstring

The ID of the Prolific workspace

namestring

The name of the collection

task_detailsobject

Task metadata displayed to participants

collection_itemslist of objects

Pages within the collection. Each collection item represents a page.

last_modified_atdatetimeOptional

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystringOptional

User ID of the Prolific user that last modified the collection

Errors

4XX

Client Request Error