Menu

Expand
Rate this page:

Alerts

Elements that can be shared among more than one endpoint definition.

Update an alert

PATCH /v3/alerts/{alert_id}

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

This endpoint allows you to update an alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, "daily", "weekly", or "monthly".

For more information about alerts, please see our Alerts documentation.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

object
email_to
string

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

frequency
string

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

percentage
integer

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

{
  "email_to": "example@example.com"
}

Path Parameters

alert_id
integer

The ID of the alert you would like to retrieve.

default: None
required

Responses

object
created_at
integer

A Unix timestamp indicating when the alert was created.

required
email_to
string

The email address that the alert will be sent to.

required
frequency
string

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

id
integer

The ID of the alert.

required
type
string

The type of alert.

Allowed Values: usage_alert, stats_notification
required
updated_at
integer

A Unix timestamp indicating when the alert was last modified.

required
percentage
integer

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.

        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more