Partially updates alert channel information

Partially updates alert channel information
Stable

Request

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

Security

esper_cloud_api_apiKey

Path

enterprise_idstring, (uuid)required

A UUID string identifying the enterprise.

alert_idintegerrequired

An integer identifying the alert channel.

Bodyapplication/json

idinteger

propertiesobject

namestring

typestring

format of alert. e.g. email

created_onstring, (date-time)

updated_onstring, (date-time)

enterprisestring, (uuid)

cURL

curl -i -X PATCH \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "properties": {
      "to_address": "user@example.com"
    },
    "name": "string",
    "type": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
  }'

Responses

successful operation