Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update an alert



API Overview

api-overview page anchor

Twilio SendGrid's Alerts feature allows you to receive notifications regarding your usage or program statistics from SendGrid at an email address you specify.

Email credit usage

email-credit-usage page anchor

Usage alerts allow you to set a threshold, when you've used 90% of your email credits, for example, at which point an alert will be sent to your email.

Statistics notifications, including email statistics, bounces, spam reports, and category statistics, can be delivered to your email address at one of three frequencies: Daily, Weekly, or Monthly.

See the Statistics Overview for more information about the various statistics SendGrid provides about your email.


PATCH/v3/alerts/{alert_id}

Base url: https://api.sendgrid.com

This endpoint allows you to update an alert.


Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

alert_idintegerrequired

The ID of the alert you would like to retrieve.

SchemaExample
email_tostring

The new email address you want your alert to be sent to. Example: test@example.com


frequencystring

The new frequency at which to send the stats_notification alert. Example: monthly


percentageinteger

The new percentage threshold at which the usage_limit alert will be sent. Example: 90

200
SchemaExample
created_atinteger

A Unix timestamp indicating when the alert was created.


email_tostring

The email address that the alert will be sent to.


frequencystring

If the alert is of type stats_notification, this indicates how frequently the stats notifications will be sent. For example: "daily", "weekly", or "monthly".


idinteger

The ID of the alert.


typeenum<string>

The type of alert.

Possible values:
usage_alertstats_notification

updated_atinteger

A Unix timestamp indicating when the alert was last modified.


percentageinteger

If the alert is of type usage_limit, this indicates the percentage of email usage that must be reached before the alert will be sent.

Update an alert

update-an-alert page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const alert_id = 4900;
_22
const data = {
_22
"email_to": "example@example.com"
_22
};
_22
_22
const request = {
_22
url: `/v3/alerts/${alert_id}`,
_22
method: 'PATCH',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: