Skip to navigation
Benchling APIWorklist

Update Worklist

Beta
Update Worklist.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

worklist_idstringRequired
ID of the Worklist.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Request

This endpoint expects an object.
addItemIdslist of stringsOptional

Add items to the worklist (incremental)

itemIdslist of stringsOptional

Set/replace all items in the worklist

namestringOptional
removeItemIdslist of stringsOptional

Remove items from the worklist by API ID (incremental)

Response

OK
__typenamestringOptional
createdAtstring or nullOptional
creatorobject or nullOptional
idstringOptional
itemTypeenumOptional
Allowed values:
itemsstringOptionalformat: "uri"
modifiedAtstring or nullOptional
namestring or nullOptional
ownerobjectOptional

Errors

400
Worklist Update Request Bad Request Error
403
Worklist Update Request Forbidden Error
404
Worklist Update Request Not Found Error
409
Worklist Update Request Conflict Error
429
Worklist Update Request Too Many Requests Error
500
Worklist Update Request Internal Server Error