---
title: "Batch update Worklist"
method: PATCH
path: "/api/v3/worklist:batch-update"
tags: ["Worklist"]
---

# Batch update Worklist

`PATCH /api/v3/worklist:batch-update`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/worklist:batch-update`
- Auth: HTTP bearer

Batch update Worklist synchronously in one transaction. Maximum 25 items per request.

## Headers

- `EARLY-ACCESS` string

## Request body

- object
  - `items` UpdateWorklistInputWithPathParams[], required
    - `addItemIds` string[]: Add items to the worklist (incremental)
    - `id` string, required
    - `itemIds` string[]: Set/replace all items in the worklist
    - `name` string
    - `removeItemIds` string[]: Remove items from the worklist by API ID (incremental)

## Response `200`

OK

- WorklistBatchupdateResponse200
  - `items` Worklist[], required
    - `__typename` string
    - `createdAt` string, datetime, nullable
    - `creator` PrincipalRef
      - `__typename` string
      - `id` string, api_id
    - `id` string
    - `itemType` 'CONTAINER' | 'ENTITY' | 'PLATE'
    - `items` string, uri
    - `modifiedAt` string, datetime, nullable
    - `name` string, nullable
    - `owner` OwnerRef
      - `__typename` string
      - `id` string, api_id

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/3873a10bf7b8?raw)