Monitor Records

Receive a sample of an outgoing message by a specific subuser.

The first step is to create a Monitor Record. Once the monitor record has been created, a reseller can append a monitor record to a subuser. Multiple subuser can be appended to a single monitor record.

Create Monitor Record

Obtain a complete list of all subuser.
Parameter Required Requirements Description
task Yes Must be set to create Create a monitor record
name Yes Name must be unique. Can’t be more than 255 characters The unique name to identify this monitor record
email Yes Must be in email format The email destination to send the email sample to
frequency Yes Subuser must be registered under your account The frequency of emails to be sent out

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=create&name=myMonitor&email=example@example.com&frequency=1000

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
</result>

Call

1

https://sendgrid.com/apiv2/customer.monitor.json?api_user=username&api_key=secureSecret&task=create&name=myMonitor&email=example@example.com&frequency=1000

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Edit Monitor Record

Make modifications to an existing Monitor record.
Parameter Required Requirements Description
task Yes Must be set to edit The task required to edit a monitor
name Yes The name of the previous monitor record The monitor record we are going to edit
new_name No New name must be unique and can’t be more than 255 characters The new monitor record name
new_email No Must be in email format The new email destination to send the email sample to
new_frequency No Must be an integer and greater than 0 The new frequency of emails to be sent out

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=edit&name=myMonitor&new_name=updatedMonitor&new_email=example@example.com&new_frequency=5

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
</result>

Call

1

https://sendgrid.com/apiv2/customer.monitor.json?api_user=username&api_key=secureSecret&task=edit&name=myMonitor&new_name=updatedMonitor&new_email=example@example.com&new_frequency=5

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Delete Monitor Record

Deleting a monitor record will remove it from SendGrid’s system. Make sure no users are currently using the monitor record when removing, or removal will fail.
Parameter Required Requirements Description
task Yes Must be set to delete The task required to remove a monitor
name Yes Must be a monitor record to remove The unique name to identify this monitor record

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=delete&name=recordToDelete

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
</result>

Call

1

https://sendgrid.com/apiv2/customer.monitor.json?api_user=username&api_key=secureSecret&task=delete&name=recordToDelete

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

List All Monitor Records

List all available monitor records a reseller has.
Parameter Required Requirements Description
task Yes Must be set to list The task required to list all monitor records

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=list

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

<?xml version="1.0" encoding="ISO-8859-1"?>

<monitors>
   <monitor>
      <name>sampleNameA</name>
      <email>example@example.com</email>
      <frequency>1000</frequency>
      <users/>
   </monitor>
   <monitor>
      <name>sampleNameB</name>
      <email>example@example.com</email>
      <frequency>10000</frequency>
      <users>
         <user>user1@example.com</user>
         <user>user2@example.com</user>
      </users>
   </monitor>
</monitors>

Call

1

https://sendgrid.com/apiv2/customer.monitor.json?api_user=username&api_key=secureSecret&task=list

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

[
  {
    "name": "sampleNameA",
    "email": "example@example.com",
    "frequency": "1000",
    "users": [

    ]
  },
  {
    "name": "sampleNameB",
    "email": "example@example.com",
    "frequency": "10000",
    "users": [
      "user1@example.com",
      "user2@example.com"
    ]
  }
]

Append A Subuser To A Monitor Record

Append a monitor record to a existing record onto a subuser.
Parameter Required Requirements Description
task Yes Must be set to append The task required to append a monitor record to a subuser
user Yes Subuser must be registered under your account The user we will append a monitor record to
name No Must be a valid monitor record The name of the monitor record we will be appending

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=append&name=myMonitor&user=example@example.com

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
</result>

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=append&name=myMonitor&user=example@example.com

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Detach A Monitor Record From A Subuser

Detach a subuser from a monitor record.
Parameter Required Requirements Description
task Yes Must be set to detach The task required to detach a monitor record to a subuser
user Yes Subuser must be registered under your account The subuser we will detach the monitor record from

Call

1

https://sendgrid.com/apiv2/customer.monitor.xml?api_user=username&api_key=secureSecret&task=detach&user=example@example.com

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
</result>

Call

1

https://sendgrid.com/apiv2/customer.monitor.json?api_user=username&api_key=secureSecret&task=detach&user=example@example.com

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}