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
}
'
import requests

url = "https://app.larm.dev/api/v1/alert-channels/{id}"

payload = {
"name": "<string>",
"config": {},
"enabled": True,
"default_for_new_monitors": True
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', config: {}, enabled: true, default_for_new_monitors: true})
};

fetch('https://app.larm.dev/api/v1/alert-channels/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.larm.dev/api/v1/alert-channels/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => [

],
'enabled' => true,
'default_for_new_monitors' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.larm.dev/api/v1/alert-channels/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {},\n \"enabled\": true,\n \"default_for_new_monitors\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://app.larm.dev/api/v1/alert-channels/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {},\n \"enabled\": true,\n \"default_for_new_monitors\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.larm.dev/api/v1/alert-channels/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {},\n \"enabled\": true,\n \"default_for_new_monitors\": true\n}"

response = http.request(request)
puts response.read_body
{
  "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"
  }
}