Menu

Alerts

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

Create a new Alert

Create a new Alert

POST /alerts

This endpoint allows you to create a new alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. There are two types of alerts that can be created with this endpoint:

  • usage_limit allows you to set the threshold at which an alert will be sent.
  • stats_notification allows 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
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
type
string

The type of alert you want to create. Can be either usage_limit or stats_notification. Example: usage_limit

Allowed Values: stats_notification, usage_limit
required
email_to
string or null

The email address the alert will be sent to. Example: test@example.com

format: email
required
frequency
string

Required for stats_notification. How frequently the alert will be sent. Example: daily

percentage
integer

Required for usage_alert. When this usage threshold is reached, the alert will be sent. Example: 90

{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}

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.

format: email
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.

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.

object
field
string
message
string
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!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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