> ## 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 specific channel by id

> Update an existing channel identified by its ID.

Only provided fields will be updated.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json patch /channels/{channel_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /channels/{channel_id}:
    patch:
      tags:
        - Channels
      summary: Update a specific channel by id
      description: |-
        Update an existing channel identified by its ID.

        Only provided fields will be updated.
      operationId: update_channel_channels__channel_id__patch
      parameters:
        - name: channel_id
          in: path
          required: true
          schema:
            type: string
            title: Channel Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Raw Data
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Channel:
      properties:
        name:
          type: string
          title: Name
          description: Name of the channel
        notes:
          anyOf:
            - type: string
            - type: 'null'
          title: Notes
          description: Free-text notes about the channel
        cycler_id:
          type: string
          title: Cycler Id
          description: Foreign key to the parent cycler
        out_of_commission:
          type: boolean
          title: Out Of Commission
          description: >-
            Whether the channel is deliberately out of service (broken or under
            maintenance). An out-of-commission channel is shown as such in the
            Lab view and is not counted as available.
          default: false
        max_amps:
          anyOf:
            - type: number
            - type: 'null'
          title: Max Amps
          description: Maximum rated current for the channel, in amps (A).
        min_volts:
          anyOf:
            - type: number
            - type: 'null'
          title: Min Volts
          description: Minimum rated voltage for the channel, in volts (V).
        max_volts:
          anyOf:
            - type: number
            - type: 'null'
          title: Max Volts
          description: Maximum rated voltage for the channel, in volts (V).
        id:
          type: string
          title: Id
          description: Unique identifier for the channel
        organization_id:
          type: string
          title: Organization Id
          description: Organization this channel belongs to.
        project_id:
          type: string
          title: Project Id
          description: Project that owns this channel (inherited from its cycler)
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: User ID of the user who created this channel
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
          description: Email of the user who created this channel
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the channel was created
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Timestamp when the channel was last updated
      type: object
      required:
        - name
        - cycler_id
        - id
        - organization_id
        - project_id
        - created_at
        - updated_at
      title: Channel
      description: Model representing a channel as returned by the API.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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

````