Partially updates alert channel information
Partially updates one or more fields of an existing alert channel identified by its integer alert_id. Only the fields included in the request body are modified — omitted fields retain their current values. Use this endpoint instead of PUT when making a targeted change to a single field without needing to resend the full channel object.
Request body fields (all optional)
name — Display name for the channel
type — Delivery format (e.g., email)
properties.to_address — The email address notifications are sent to
Common use cases
Updating only the destination email address without affecting the channel name or type
Renaming a channel without modifying its delivery configuration
Making a quick correction to a single field after creation
Best practices
Prefer this endpoint over PUT for single-field changes — it reduces payload size and eliminates the risk of accidentally clearing fields that are not included in the body
Note that alert_id is an integer, not a UUID — use GET /alertchannels/ with the name filter to look it up if needed
Changes to properties.to_address take effect immediately and affect all alarm rules currently linked to this channel — review linked_alerts via GET /alertchannels/{alert_id} before updating the destination if multiple rules depend on it
Path parameters
A UUID string identifying the enterprise.
An integer identifying the alert channel.
Request body
Response
successful operation