> This page is for Developer Documentation.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.benchling.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server.

# Update Study

PATCH https://{tenant_name}.benchling.com/api/v3/study/{study_id}
Content-Type: application/json

Update a study. Omit any field to leave it unchanged.

## Editable fields

`name`, `description`, `folderId`, and `schemaFields` can be updated. Keys in `schemaFields` must be field system names or field API IDs.

## phase

- See the `phase` field for the full list of allowed lifecycle values.
- Study types that skip the design phase cannot be set to `DESIGN`.
- Moving from `DESIGN` to `EXECUTION` requires an approved study design when the schema requires design approval.

## designEntryId and designEntry

- `designEntryId` is only supported for custom studies. Omit to leave the design entry unchanged, or pass `null` to remove it.
- On a custom study in `EXECUTION` under a schema that requires design approval, `designEntryId` cannot change unless the same update also moves the study into `DESIGN`.
- Use `designEntry` to create a new entry and set it as the design entry in one request. It cannot be combined with `designEntryId`.

## displayId

- Only allowed when the study schema's `idGenerationMode` is `MANUAL`. Providing `displayId` for an auto-generating schema fails validation.
- When provided, must be unique within the tenant.
- Omitting `displayId` leaves the current value unchanged.

## authorIds

- Omit to leave existing authors unchanged.
- Provide an array of user or app IDs to replace the current author list.
- Pass an empty array to clear all authors.
- Do not pass `null`.

## Archiving

- To archive, set `archived` to `true` and provide `archiveReason`.
- To unarchive, set `archived` to `false`.

Reference: https://docs.benchling.com/docs/api/benchling-api/study/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `study_id` (string, required) — ID of the Study.

### Body (application/json)

This endpoint expects an object.

- `archiveReason` (string, optional)
- `archived` (boolean, optional)
- `authorIds` (list of string, optional) — The IDs of the users or apps to set as study authors. Omit to leave authors unchanged. Pass an empty array to clear all authors.
- `description` (string, optional) — The description of the study. Omit to leave unchanged. Max 2048 characters.
- `designEntry` (CreateStudyDesignEntryInput, optional) — Create a new entry to use as the study design entry. Cannot be combined with designEntryId.
- `designEntryId` (string, optional, nullable) — The ID of an entry to use as the study design entry. Omit to leave unchanged. Pass null to remove the design entry. Only supported for custom studies. On a custom study in EXECUTION under a schema that requires design approval, this cannot be changed unless the update also moves the study into the DESIGN phase.
- `displayId` (string, optional) — The ID to assign to the study. Only allowed when the study schema is configured for manual ID assignment (i.e., `idGenerationMode` is `MANUAL`). Must be unique within the tenant.
- `folderId` (string, optional) — The ID of the folder to move the study to. Omit to leave unchanged.
- `name` (string, optional) — The name of the study. Omit to leave unchanged.
- `phase` (enum, optional) — The lifecycle phase of the study. Omit to leave unchanged. See the endpoint description for transition rules.
  - Allowed values: `DESIGN`, `EXECUTION`, `COMPLETE`
- `schemaFields` (map from string to FieldValueInput, optional)
- `fieldValues` (list of UpdateFieldValueInput, optional, deprecated) — Use schemaFields instead.

## Response

### 200

OK

- `__typename` (string, optional)
- `archiveReason` (string, optional, nullable)
- `archived` (boolean, optional)
- `authors` (string, optional, nullable) — Users and apps designated as authors of the study.
- `createdAt` (string, optional, nullable)
- `creator` (PrincipalRef, optional)
- `description` (string, optional, nullable)
- `designEntry` (EntryRef, optional, nullable)
- `displayId` (string, optional, nullable) — Human-readable identifier for the study. For schemas with auto-generated IDs, assigned by the server at creation. For MANUAL schemas, may be set at creation or update.
- `folder` (FolderRef, optional)
- `id` (string, optional)
- `modifiedAt` (string, optional, nullable)
- `name` (string, optional)
- `phase` (enum, optional, nullable)
  - Allowed values: `DESIGN`, `EXECUTION`, `COMPLETE`
- `schema` (StudySchemaRef, optional, nullable)
- `schemaFields` (list of SchemaFieldValue, optional, nullable)
- `studySchema` (StudySchemaRef, optional) — Use schema instead. The schema of the study.
- `archiveDatetime` (string, optional, nullable, deprecated) — No longer supported.
- `archiveUser` (PrincipalRef, optional, nullable, deprecated) — No longer supported.

## Errors

### 400 Study Update Request Bad Request Error

Bad Request

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 403 Study Update Request Forbidden Error

Forbidden

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 404 Study Update Request Not Found Error

Not Found

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 409 Study Update Request Conflict Error

Conflict

- `detail` (GeneralErrorDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)

### 429 Study Update Request Too Many Requests Error

Too Many Requests

- `detail` (TooManyRequestsErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `invalidId` (string, optional)
- `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`.
  - Allowed values: `user`, `integration`, `tenant`

### 500 Study Update Request Internal Server Error

Internal Server Error

- `detail` (InternalServerErrorBodyDetail, required, nullable)
- `instance` (string, required)
- `status` (integer, required)
- `title` (string, required, nullable)
- `type` (string, required)
- `errorId` (string, optional)

## Types

### CreateStudyDesignEntryInput

- `folderId` (string, required)
- `name` (string, required)
- `initialDay` (string, optional)
- `schemaFields` (map from string to FieldValueInput, optional)
- `schemaId` (string, optional) — The ID of the schema to associate with this object.
- `templateId` (string, optional)

### FieldValueInput

- `value` (any, required)

### UpdateFieldValueInput

- `fieldDefinitionId` (string, required)
- `value` (any, required)

### PrincipalRef

- `__typename` (string, optional)
- `id` (string, optional)

### EntryRef

- `__typename` (string, optional)
- `id` (string, optional)

### FolderRef

- `__typename` (string, optional)
- `id` (string, optional)

### StudySchemaRef

- `__typename` (string, optional)
- `id` (string, optional)

### SchemaFieldValue

Represents a field value on a schematized object, pairing a `fieldDefinition` (describing the field's type and constraints) with its actual `value` (a `BenchlingValue` such as text, number, date, or link to another object). The value may be null if no value has been set. Used within the `schemaFields` collection on objects that implement `HasSchema` to provide access to all custom field values defined by the object's schema.

- `__typename` (string, optional)
- `fieldDefinition` (SchemaFieldDefinitionRef, optional)
- `id` (string, optional)
- `linkedEntityId` (string, optional, nullable)
- `value` (SchemaFieldValueValue, optional, nullable) — Union of BooleanValue, DateTimeValue, DateValue, DecimalValue, IntegerValue, JsonValue, ObjectLinkValue, ObjectLinkListValue, TextAndUrlValue, TextValue, ArrayValue

### GeneralErrorDetail

### TooManyRequestsErrorBodyDetail

### InternalServerErrorBodyDetail

### SchemaFieldDefinitionRef

- `__typename` (string, optional)
- `id` (string, optional)

### SchemaFieldValueValue

### BooleanValue

A type that represents boolean values.

- `__typename` (string, optional)
- `value` (boolean, optional) — The boolean value.

### DateTimeValue

A type that represents datetime values.

- `__typename` (string, optional)
- `value` (string, optional) — The datetime value with UTC as the timezone.

### DateValue

A type that represents date values.

- `__typename` (string, optional)
- `value` (date, optional) — The date value.

### DecimalValue

A type that represents decimal value as strings.

- `__typename` (string, optional)
- `value` (string, optional, nullable) — The decimal value in a string representation
- `numericValue` (double, optional, nullable, deprecated) — Deprecated. The float representation of the decimal value.

### IntegerValue

A type that represents integer values.

- `__typename` (string, optional)
- `value` (integer, optional) — The integer value.

### JsonValue

A type that represents JSON values.

- `__typename` (string, optional)
- `value` (map from string to any, optional) — The JSON value.

### ObjectLinkValue

A type that represents links to other objects.

- `__typename` (string, optional)
- `value` (ObjectRef, optional) — The object that this value links to, or an Inaccessible object if not found with the current permission set.

### ObjectLinkListValue

A type that represents a list of links to other objects.

- `__typename` (string, optional)
- `value` (list of ObjectRef, optional) — The list of objects that this value links to. Inaccessible objects may be returned instead if the object is not found with the current permission set.

### TextAndUrlValue

A type that represents text (string) values with an associated URL.

- `__typename` (string, optional)
- `url` (string, optional) — The URL associated with the value. Please use `TextValue` if you don't want a URL.
- `value` (string, optional) — The text value. It may or may not be an empty string.

### TextValue

A type that represents text (string) values.

- `__typename` (string, optional)
- `value` (string, optional) — The text value. It may or may not be an empty string.

### ArrayValue

A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).

- `__typename` (string, optional)
- `value` (list of ArrayValueValueItem, optional)

### ObjectRef

- `__typename` (string, optional)
- `id` (string, optional)

### ArrayValueValueItem

Union of BooleanValue, DateTimeValue, DateValue, DecimalValue, IntegerValue, JsonValue, ObjectLinkValue, ObjectLinkListValue, TextAndUrlValue, TextValue

## Examples

**Request**

```json
{
  "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"
    }
  }
}
```

**Response**

```json
{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "authors": "authors",
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "description": "description",
  "designEntry": {
    "__typename": "__typename",
    "id": "id"
  },
  "displayId": "displayId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "phase": "DESIGN",
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "studySchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "archiveUser": {
    "__typename": "__typename",
    "id": "id"
  }
}
```

**SDK Code**

```python
import requests

url = "https://{tenant_name}.benchling.com/api/v3/study/study_id"

payload = {
    "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" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{tenant_name}.benchling.com/api/v3/study/study_id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"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"}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```