PRprolific
aiTaskBuilder

Update a Collection

Changed on

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.

put/api/v1/data-collection/collections/{collection_id}

Request

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

Path parameters

collection_idstring required

Request body

namestring required

The name of the collection

Response

OK

idstring uuid required
schema_version'1' required
created_atstring date-time required

ISO-8601 formatted creation timestamp in UTC

created_bystring required

User ID of the Prolific user that created the collection

workspace_idstring required

The ID of the Prolific workspace

namestring required

The name of the collection

last_modified_atstring date-time

ISO-8601 formatted last modification timestamp in UTC

last_modified_bystring

User ID of the Prolific user that last modified the collection

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-collection removed and replaced with aiTaskBuilder_UpdateCollection