---
title: "Update a specific channel by id"
method: PATCH
path: "/channels/{channel_id}"
tags: ["Channels"]
---

# Update a specific channel by id

`PATCH /channels/{channel_id}`

## Request

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

Update an existing channel identified by its ID.

Only provided fields will be updated. Taking a channel out of service (or
returning it) also records an outage span; ``user_id`` is threaded through so
the incident records who did it.

## Path parameters

- `channel_id` string, uuid, required

## Request body

- object

## Response `200`

Successful Response

- Channel: Model representing a channel as returned by the API.
  - `name` string, required: Name of the channel
  - `notes` string, nullable: Free-text notes about the channel
  - `cycler_id` string, required: Foreign key to the parent cycler
  - `max_amps` number, nullable: Maximum rated current for the channel, in amps (A).
  - `min_volts` number, nullable: Minimum rated voltage for the channel, in volts (V).
  - `max_volts` number, nullable: Maximum rated voltage for the channel, in volts (V).
  - `id` string, required: Unique identifier for the channel
  - `out_of_commission` boolean: 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.
  - `organization_id` string, required: Organization this channel belongs to.
  - `project_id` string, required: Project that owns this channel (inherited from its cycler)
  - `created_by` string, nullable: User ID of the user who created this channel
  - `created_by_email` string, nullable: Email of the user who created this channel
  - `created_at` string, date-time, required: Timestamp when the channel was created
  - `updated_at` string, date-time, required: Timestamp when the channel was last updated

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `path` request parameter `channel_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/channels/:channel_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)