On this page

Update an alert

API Overview

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

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 summary

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.

Operation overview

PATCH/v3/alerts/{alert_id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to update an alert.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Path parameters

Property nameTypeRequiredDescription

alert_idintegerrequired

The ID of the alert you would like to retrieve.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

email_tostringOptional

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

frequencystringOptional

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

percentageintegerOptional

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

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

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_limitstats_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

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const alert_id = 4900;
5const data = {
6  email_to: "example@example.com",
7};
8
9const request = {
10  url: `/v3/alerts/${alert_id}`,
11  method: "PATCH",
12  body: data,
13};
14
15client
16  .request(request)
17  .then(([response, body]) => {
18    console.log(response.statusCode);
19    console.log(response.body);
20  })
21  .catch((error) => {
22    console.error(error);
23  });