Menu

Expand
Rate this page:

Subuser Monitor Settings

Subuser monitor settings allow you to receive a sample of an outgoing message from a specific customer at a specific frequency of emails.

Retrieve monitor settings for a subuser

Twilio SendGrid will retire Email Monitor on December 13, 2022. If Email Monitor is essential to your experience, please adapt your workflow or build a custom solution to fit your needs prior to this date.

GET /v3/subusers/{subuser_name}/monitor

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

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

subuser_name
string

The name of the subuser for which to retrieve monitor settings.

default: None
required

Responses

object
email
string

The email address to which Sendgrid should send emails for monitoring.

format: email
required
frequency
number

The frequency at which to forward monitoring emails. An email will be sent when your subuser sends this many (e.g., 1,000) emails.

required
{
  "email": "example@example.com",
  "frequency": 50000
}
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              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