---
title: "Update a specific cell instance by id"
method: PATCH
path: "/cell_instances/{cell_instance_id}"
tags: ["Cell Instances"]
---

# Update a specific cell instance by id

`PATCH /cell_instances/{cell_instance_id}`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/cell_instances/{cell_instance_id}`
- Auth: none declared

Updates an existing cell instance identified by its ID.
Only provided fields will be updated.

## Path parameters

- `cell_instance_id` string, uuid, required

## Request body

- object

## Response `200`

Successful Response

- CellInstance: Model representing a cell instance as returned by the API.
  - `is_failed` boolean: Whether it was reported as failed.
  - `failure_reason` string, nullable: Why it failed.
  - `failed_at` string, date-time, nullable: When it was reported.
  - `failed_by` string, nullable: User who reported it.
  - `name` string, required: Name of the cell instance (serial number)
  - `batch_id` string, uuid, nullable: Manufacturing lot (cell batch) this cell came from. Must be a batch of the same cell specification.
  - `date_manufactured` string, date, nullable: Date of manufacture
  - `measured_properties` object, nullable: Measured (not designed) properties of this specific cell, grouped by component. Numeric values use the Quantity format. Example: {'cathode': {'loading': {'value': 7.06, 'unit': 'mg.cm-2'}}, 'cell': {'initial_capacity': {'value': 1.08, 'unit': 'A.h'}}}. Designed properties (target loading, rated capacity) belong on the cell specification.
  - `notes` string, nullable: Free-text notes about the cell instance
  - `id` string, required: Unique identifier for the cell instance
  - `cell_specification_id` string, required: Foreign key to the cell specification
  - `organization_id` string, required: Organization this cell instance belongs to.
  - `project_id` string, required: Project this cell instance belongs to
  - `created_by` string, nullable: User ID of the user who created this instance
  - `created_by_email` string, nullable: Email of the user who created this instance
  - `created_at` string, date-time, required: Timestamp when the instance was created
  - `updated_at` string, date-time, required: Timestamp when the instance was last updated
  - `batch_name` string, nullable: Name of the batch ``batch_id`` points at. Read-only.
  - `measurement_ids` object[], nullable: List of measurement IDs associated with the cell instance

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-24** `f4c74e855466`: 4 info
  - added the optional property `failed_at` to the response with the `200` status
  - added the optional property `failed_by` to the response with the `200` status
  - added the optional property `failure_reason` to the response with the `200` status
  - added the optional property `is_failed` to the response with the `200` status
- **2026-10-04** `1f50d4b61910`: 1 warning, 2 info
  - removed the optional property `batch` from the response with the `200` status
  - added the optional property `batch_id` to the response with the `200` status
  - added the optional property `batch_name` to the response with the `200` status
- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `path` request parameter `cell_instance_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/cell_instances/:cell_instance_id/patch.md)

---

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