Update Deliverability Alert
curl --request PATCH \
--url https://api.lemlist.com/api/deliverability/alerts/{alertId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"threshold": 7,
"channelConfig": {
"inapp": {
"enabled": true
},
"email": {
"enabled": true,
"addresses": [
"alerts@example.com",
"ops@example.com"
]
}
}
}
'import requests
url = "https://api.lemlist.com/api/deliverability/alerts/{alertId}"
payload = {
"threshold": 7,
"channelConfig": {
"inapp": { "enabled": True },
"email": {
"enabled": True,
"addresses": ["alerts@example.com", "ops@example.com"]
}
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
threshold: 7,
channelConfig: {
inapp: {enabled: true},
email: {enabled: true, addresses: ['alerts@example.com', 'ops@example.com']}
}
})
};
fetch('https://api.lemlist.com/api/deliverability/alerts/{alertId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/deliverability/alerts/{alertId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"threshold\": 7,\n \"channelConfig\": {\n \"inapp\": {\n \"enabled\": true\n },\n \"email\": {\n \"enabled\": true,\n \"addresses\": [\n \"alerts@example.com\",\n \"ops@example.com\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/deliverability/alerts/{alertId}",
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([
'threshold' => 7,
'channelConfig' => [
'inapp' => [
'enabled' => true
],
'email' => [
'enabled' => true,
'addresses' => [
'alerts@example.com',
'ops@example.com'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"_id": "dac_A1B2C3D4E5F6G7H8I",
"teamId": "tea_ExampleAcmeTeamId",
"createdBy": "usr_ExampleAcmeUserId",
"createdAt": "2026-04-12T09:30:00.000Z",
"updatedAt": "2026-05-07T10:15:00.000Z",
"widget": "outreach",
"metric": "bounceRate",
"severity": "critical",
"scope": "mailbox",
"scopeEntities": [
"usr_ExampleAcmeUserId|john@example.com|usm_ExampleMailboxId"
],
"threshold": 7,
"comparisonOperator": "above",
"periodDays": 1,
"periodMode": "rolling",
"channelConfig": {
"inapp": {
"enabled": true
},
"email": {
"enabled": true,
"addresses": [
"alerts@example.com",
"ops@example.com"
]
}
},
"enabled": true,
"lastCheckedAt": "2026-05-07T07:00:00.000Z",
"lastTriggeredAt": "2026-05-06T18:42:11.000Z",
"recheckDelayHours": 12
}Deliverability alerts
Update Deliverability Alert
Updates a deliverability alert’s threshold, evaluation window, notification channels, scope filter, or enabled state.
PATCH
/
deliverability
/
alerts
/
{alertId}
Update Deliverability Alert
curl --request PATCH \
--url https://api.lemlist.com/api/deliverability/alerts/{alertId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"threshold": 7,
"channelConfig": {
"inapp": {
"enabled": true
},
"email": {
"enabled": true,
"addresses": [
"alerts@example.com",
"ops@example.com"
]
}
}
}
'import requests
url = "https://api.lemlist.com/api/deliverability/alerts/{alertId}"
payload = {
"threshold": 7,
"channelConfig": {
"inapp": { "enabled": True },
"email": {
"enabled": True,
"addresses": ["alerts@example.com", "ops@example.com"]
}
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
threshold: 7,
channelConfig: {
inapp: {enabled: true},
email: {enabled: true, addresses: ['alerts@example.com', 'ops@example.com']}
}
})
};
fetch('https://api.lemlist.com/api/deliverability/alerts/{alertId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://api.lemlist.com/api/deliverability/alerts/{alertId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"threshold\": 7,\n \"channelConfig\": {\n \"inapp\": {\n \"enabled\": true\n },\n \"email\": {\n \"enabled\": true,\n \"addresses\": [\n \"alerts@example.com\",\n \"ops@example.com\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lemlist.com/api/deliverability/alerts/{alertId}",
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([
'threshold' => 7,
'channelConfig' => [
'inapp' => [
'enabled' => true
],
'email' => [
'enabled' => true,
'addresses' => [
'alerts@example.com',
'ops@example.com'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"_id": "dac_A1B2C3D4E5F6G7H8I",
"teamId": "tea_ExampleAcmeTeamId",
"createdBy": "usr_ExampleAcmeUserId",
"createdAt": "2026-04-12T09:30:00.000Z",
"updatedAt": "2026-05-07T10:15:00.000Z",
"widget": "outreach",
"metric": "bounceRate",
"severity": "critical",
"scope": "mailbox",
"scopeEntities": [
"usr_ExampleAcmeUserId|john@example.com|usm_ExampleMailboxId"
],
"threshold": 7,
"comparisonOperator": "above",
"periodDays": 1,
"periodMode": "rolling",
"channelConfig": {
"inapp": {
"enabled": true
},
"email": {
"enabled": true,
"addresses": [
"alerts@example.com",
"ops@example.com"
]
}
},
"enabled": true,
"lastCheckedAt": "2026-05-07T07:00:00.000Z",
"lastTriggeredAt": "2026-05-06T18:42:11.000Z",
"recheckDelayHours": 12
}widget, metric, severity, and scope are immutable. To change one of them, delete this alert and create a new one.Common updates
- Pause/resume an alert by sending
{"enabled": false}or{"enabled": true}. - Tune sensitivity by adjusting
threshold,periodDays, orperiodMode. - Add a channel by sending the full
channelConfigwith the new channel set toenabled: true. Channels you omit are left untouched. - Restrict the scope by sending
scopeEntities(only meaningful whenscopeismailboxordomain).
Authorizations
Body
application/json
All fields are optional. Only the supplied fields are updated. widget, metric, severity, and scope cannot be changed after creation — create a new alert if you need different dimensions.
Response
Alert updated
A deliverability alert configuration. The alert is evaluated periodically against your warm-up or outreach metrics and triggers notifications through the configured channels (in-app, email, webhook, Slack) when the threshold is breached.
Was this page helpful?