> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a cell measurement by id

> Update an existing cell measurement's metadata.

Only metadata fields can be updated (name, protocol, test_setup, notes, properties).
Time series and steps data cannot be modified.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json patch /cell_measurements/{measurement_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /cell_measurements/{measurement_id}:
    patch:
      tags:
        - Cell Measurements
      summary: Update a cell measurement by id
      description: >-
        Update an existing cell measurement's metadata.


        Only metadata fields can be updated (name, protocol, test_setup, notes,
        properties).

        Time series and steps data cannot be modified.
      operationId: update_cell_measurement_cell_measurements__measurement_id__patch
      parameters:
        - name: measurement_id
          in: path
          required: true
          schema:
            type: string
            title: Measurement Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCellMeasurement'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellMeasurement'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdateCellMeasurement:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Name
        protocol:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Protocol
          description: >-
            Protocol information as a dict with: name (str),
            ambient_temperature_degc (float), definition (dict | str - UCP or
            other protocol format)
        test_setup:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Test Setup
          description: 'Test setup: cycler, operator, lab, etc.'
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
          description: >-
            When the test finished (ISO 8601 with timezone). Set this to mark
            the measurement complete; leave null while it is still running.
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
        channel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Channel Id
          description: Optional ID of the channel this measurement ran on.
        properties:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Properties
          description: >-
            Key-value measurements using Quantity format for numerics. Only for
            measurement_type='properties'. Example: {'thickness': {'value':
            0.52, 'unit': 'mm'}}
      type: object
      title: UpdateCellMeasurement
      description: Model for updating an existing cell measurement. All fields optional.
    CellMeasurement:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        protocol:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Protocol
          description: >-
            Protocol information. Typical keys: 'name' (str),
            'ambient_temperature_degc' (float), 'definition' (dict | str — a UCP
            protocol definition or another protocol format).
        start_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Start Time
          description: >-
            ISO 8601 datetime with timezone (UTC preferred) marking when the
            test started.
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
          description: >-
            ISO 8601 datetime with timezone (UTC preferred) marking when the
            test finished. Leave null while the test is still running; set it
            once the measurement is complete. A null end_time means the cell is
            still considered 'on test' in the Lab view.
        test_setup:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Test Setup
          description: >-
            Physical test setup. Typical keys: 'cycler' (model), 'operator',
            'lab', 'channel_number' (int).
        step_labels_validated:
          type: boolean
          title: Step Labels Validated
          description: >-
            Set to true only once step-type labels (Rest, CC charge, CV,
            discharge, etc.) have been manually reviewed. Server-inferred labels
            should leave this false.
          default: false
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
          description: Free-text notes about the cell measurement
        measurement_type:
          $ref: '#/components/schemas/MeasurementType'
          description: >-
            What shape of data this measurement holds. Determines which fields
            are populated and which upload flow applies. See the class
            docstring.
          default: time_series
        properties:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Properties
          description: >-
            Flat key/value measurements, populated only when measurement_type is
            'properties'. Numeric values use the Quantity format. Example:
            {'thickness': {'value': 0.52, 'unit': 'mm'}, 'DCIR': {'value': 12,
            'unit': 'mohm'}}.
        file_metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: File Metadata
          description: Metadata about uploaded files (MIME types, dimensions, etc.)
        channel_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Channel Id
          description: Optional ID of the channel this measurement ran on.
        id:
          type: string
          title: Id
        cell_instance_id:
          type: string
          title: Cell Instance Id
        organization_id:
          type: string
          title: Organization Id
          description: Organization this measurement belongs to.
        project_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Project Id
          description: Project this measurement belongs to
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: User ID of the user who created this measurement
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
          description: Email of the user who created this measurement
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - name
        - id
        - cell_instance_id
        - organization_id
        - created_at
        - updated_at
      title: CellMeasurement
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MeasurementType:
      type: string
      enum:
        - time_series
        - file
        - properties
      title: MeasurementType
      description: |-
        Shape of the data stored in a cell measurement.

        - ``time_series`` — cycling / diagnostic data uploaded as columnar
          time series (and optional step summaries). Default for new
          measurements.
        - ``file`` — an opaque file upload (raw cycler export, image, other
          binary). Metadata about the file is captured in
          ``file_metadata``; the file content lives in object storage.
        - ``properties`` — a flat key/value set of measured properties
          (thickness, mass, DCIR, initial capacity, …) with no time-series
          data. Numeric values use the Quantity format.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````