---
title: "Update a worklist"
method: PATCH
path: "/worklists/{worklist_id}"
tags: ["worklists"]
---

# Update a worklist

`PATCH /worklists/{worklist_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2-beta`
- URL: `https://{tenant_name}.benchling.com/api/v2-beta/worklists/{worklist_id}`
- Auth: HTTP bearer

Update a worklist

## Path parameters

- `worklist_id` string, required

## Request body

- WorklistUpdate
  - `name` string: Name of the worklist
  - `worklistItemIds` string[]: An ordered set of IDs to assign as worklist items. IDs should reference existing items which fit the worklist's specific type. For instance, a worklist of type container should only have item IDs which represent containers. Replaces any existing worklist items with this set.

## Response `200`

OK

- Worklist: A worklist and its items as summaries.
  - `apiURL` string, uri: The canonical url of the Worklist in the API.
  - `createdAt` string, date-time: Date and time the worklist was created
  - `creator` WorklistCreator: UserSummary of the user who created the worklist
    - `handle` string
    - `id` string
    - `name` string
  - `id` string: ID of the worklist
  - `modifiedAt` string, date-time: Date and time the worklist was last modified
  - `name` string: Name of the worklist
  - `type` 'batch' | 'bioentity' | 'container' | 'plate': The type of items a worklist contains.
  - `worklistItems` WorklistItemSummary[]
    - `id` string: ID of the item
    - `name` string: Name of the item

## Other responses

- `400`: Bad Request

---

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