Retrieve, delete and add entries in the Unsubscribes list.

get

Retrieve a list of Unsubscribes with addresses and optionally with dates.

Parameter Required Requirements Description
date No Must be set to 1 Retrieve the timestamp of the unsubscribe records. It will return a date in a MySQL timestamp format - YYYY-MM-DD HH:MM:SS
days No If specified, must be an integer greater than 0 Number of days in the past for which to retrieve unsubscribes (includes today)
start_date No Date must be in YYYY-MM-DD format and be earlier than the end_date parameter. The start of the date range for which to retrieve unsubscribes.
end_date No Date must be in YYYY-MM-DD format and be later than the start_date parameter. The end of the date range for which to retrieve unsubscribes.
limit No some integer Optional field to limit the number of results returned.
offset No some integer optional beginning point in the list to retrieve from.
email No email address eg testing@example.com optional email addresses to search for.

Call

GET https://api.sendgrid.com/api/unsubscribes.get.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
[
  {
    "email": "brandon.west@sendgrid.com",
    "created": "2012-09-06 14:03:18"
  }
]

Call

GET https://api.sendgrid.com/api/unsubscribes.get.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password&date=1

Response

1
2
3
4
5
6
<unsubscribes>
  <unsubscribe>
    <email>brandon.west@sendgrid.com</email>
    <created>2012-09-06 14:03:18</created>
  </unsubscribe>
</unsubscribes>

delete

Delete an address from the Unsubscribe list. Please note that if no parameters are provided or if empty parameters are provided the ENTIRE list will be removed.

Parameter Required Requirements Description
email No Must be a valid user account email Unsubscribed email address to remove

Call

POST https://api.sendgrid.com/api/unsubscribes.delete.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

1
2
3
4
5
6
7
8
9
10
11
12
//success
{
  "message": "success"
}

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

Call

POST https://api.sendgrid.com/api/unsubscribes.delete.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com

Response

1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<result>
   <message>success</message>
</result>

<!-- error -->
<result>
   <message>Email does not exist</message>
</result>

add

Add email addresses to the Unsubscribe list.

Parameter Required Requirements Description
email Yes Must be a valid email address Email address to add to unsubscribe list

Call

POST https://api.sendgrid.com/api/unsubscribes.add.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=email2@domain.com

Response

1
2
3
4
5
6
7
8
9
10
11
12
//success
{
  "message": "success"
}

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

Call

POST https://api.sendgrid.com/api/unsubscribes.add.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=email2@domain.com

Response

1
2
3
4
5
6
7
8
9
10
11
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<result>
   <message>success</message>
</result>

<!-- error -->
<result>
   <message>Email does not exist</message>
</result>