Skip to content

Update a radio channel

Safety module

PATCH/radio-channels/{id}radioChannels.update

A radio channel in the org radio plan, listed in numeric order. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability safety.radio_channel.write.
  • OAuth scopes: safety.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

radioChannels.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the radio channel.

Request body: RadioChannelUpdate

radioChannels.update: RadioChannelUpdate
FieldTypeRequiredDescription
channel_numberintegerNoChannel number.Constraints: range 1 to any
namestringNoChannel name.Constraints: length 1 to 300
zone_idstring (uuid) | nullNoIdentifier of the zone the channel covers.
{
  "channel_number": 1,
  "name": "Production",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: RadioChannel

radioChannels.update: RadioChannel
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the radio channel.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
channel_numberintegerYesChannel number.Constraints: range 1 to any
namestringYesChannel name.Constraints: length 1 to 300
project_idstring (uuid)YesIdentifier of the project.
zone_idstring (uuid) | nullYesIdentifier of the zone the channel covers.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "channel_number": 1,
  "name": "Production",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/radio-channels/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"channel_number":1,"name":"Production","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.radioChannels.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "channel_number": 1,
    "name": "Production",
    "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.radio_channels.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"channel_number": 1, "name": "Production", "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos radio-channels update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"channel_number":1,"name":"Production","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto