Skip to content

Update alert channel information
Stable

Request

Fully updates an existing alert channel identified by its integer alert_id. All writable fields should be included in the request body — this is a full replacement operation, not a partial update. To change only one field without affecting others, use PATCH /v1/enterprise/{enterprise_id}/alertchannels/{alert_id} instead.

Request body fields

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 the destination email address for a channel (e.g., when a team's distribution list changes)

Renaming a channel to better reflect its current purpose or recipients

Correcting a misconfigured channel after creation

Best practices

Retrieve the current channel state with GET /v1/enterprise/{enterprise_id}/alertchannels/{alert_id} before updating — since this is a full replacement, omitting fields may clear them unintentionally

Prefer PATCH over PUT when only a single field needs to change, to reduce the risk of accidental data loss

Note that alert_id is an integer, not a UUID — use GET /alertchannels/ to look it up if needed

Updating the destination address on a channel affects all alarm rules linked to it immediately — review linked_alerts on the channel before making changes that will affect notification routing

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/jsonrequired
idinteger
propertiesobject
namestring
typestring

format of alert. e.g. email

created_onstring, (date-time)
updated_onstring, (date-time)
enterprisestring, (uuid)
cURL
curl -i -X PUT \
  '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

Bodyapplication/json
idinteger
propertiesobject
namestring
typestring

format of alert. e.g. email

created_onstring, (date-time)
updated_onstring, (date-time)
enterprisestring, (uuid)
linked_alertsArray of strings
Response
{ "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", "linked_alerts": [ "string" ] }