Batch update Study

PATCH

https://{tenant_name}.benchling.com/api/v3/study:batch-update

PATCH

/api/v3/study:batch-update

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/study:batch-update \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "id": "stdy_9CYiCggY",
      "archiveReason": "Archived",
      "archived": true,
      "authorIds": [
        "ent_a0SApq3z",
        "ent_t40Vb4aA"
      ],
      "description": "Updated Study Description",
      "designEntry": {
        "folderId": "lib_o2thOLlq",
        "name": "New Design Entry"
      },
      "displayId": "CSWNAR1",
      "folderId": "lib_o2thOLlq",
      "name": "Updated Study Name",
      "phase": "EXECUTION",
      "schemaFields": {
        "boolean_field_system_name": {
          "value": false
        },
        "date_field_system_name": {
          "value": "2025-06-15"
        },
        "datetime_field_system_name": {
          "value": "2025-06-15T09:00:00Z"
        },
        "dropdown_field_system_name": {
          "value": "sfso_UcQuhAwx"
        },
        "entity_field_system_name": {
          "value": [
            "bfi_jdf8BV24"
          ]
        },
        "number_field_system_name": {
          "value": 456
        },
        "text_field_system_name": {
          "value": "Updated text value"
        }
      }
    }
  ]
}'

{
  "items": [
    {
      "__typename": "__typename",
      "archiveReason": "archiveReason",
      "archived": true,
      "authors": "authors",
      "createdAt": "createdAt",
      "description": "description",
      "displayId": "displayId",
      "id": "id",
      "modifiedAt": "modifiedAt",
      "name": "name",
      "phase": "DESIGN",
      "schemaFields": [
        {}
      ]
    }
  ]
}

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

itemslist of objectsRequired

Response

itemslist of objects

Errors

400

Study Batch Update Request Bad Request Error

403

Study Batch Update Request Forbidden Error

404

Study Batch Update Request Not Found Error

409

Study Batch Update Request Conflict Error

429

Study Batch Update Request Too Many Requests Error

500

Study Batch Update Request Internal Server Error