Skip to main content
PATCH
/
api
/
v1
/
alert-channels
/
{id}
Update alert channel
curl --request PATCH \
  --url https://app.larm.dev/api/v1/alert-channels/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {},
  "enabled": true,
  "default_for_new_monitors": true
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Ops Slack",
    "type": "slack",
    "enabled": true,
    "default_for_new_monitors": false,
    "broken_at": null,
    "broken_reason": null,
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T14:30:00Z"
  }
}
Requires alert_channels:read_write permission. Only include the fields you want to change.
​
id
string
required
Alert channel ID (UUID)
​
name
string
Channel name (1–255 characters)
​
config
object
Type-specific configuration. See Alert channels for fields per type.
​
enabled
boolean
Whether the channel is active
​
default_for_new_monitors
boolean
Automatically link to newly created monitors
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Ops Slack",
    "type": "slack",
    "enabled": true,
    "default_for_new_monitors": false,
    "broken_at": null,
    "broken_reason": null,
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T14:30:00Z"
  }
}