Retrieve Unsubscribes

Note that you can use either the days parameter or the start_date and end_date parameter.
Parameter Required Requirements Description
user Yes Subuser must be registered under your account The subuser we are retrieving unsubscribes from
task Yes Must be set to get This will allow you to retrieve the unsubscribes for the specified subuser
date No Must be set to 1 Retrieves the timestamps, it will return a date in a MySQL timestamp format - YYYY-MM-DD HH:MM:SS

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=get&date=

Response

1
2
3
4
5
6
7
8
9
10
[
  {
    "email": "email1@domain.com",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "email2@domain2.com",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=get&date=

Response

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

<unsubscribes>
   <unsubscribe>
      <email>email1@domain.com</email>
      <created>2009-06-10 12:40:30</created>
   </unsubscribe>
   <unsubscribe>
      <email>email2@domain2.com</email>
      <created>2009-06-10 12:40:30</created>
   </unsubscribe>
</unsubscribes>

Delete Unsubscribes

Since SendGrid does not deliver to unsubscribe addresses, users can remove unsubscribes from their list at any time if re-delivery to an unsubscribed address is desired.
Parameter Required Requirements Description
user Yes Subuser must be registered under your account The subuser we are retrieving unsubscribes from
task Yes Must be set to delete This will allow you to delete an unsubscribe record for the specified subuser
email No Must be an unsubscribe record You must specify the unsubscribe record to remove

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=delete&email=unsubscribe@sample.com

Response

1
2
3
4
5
6
7
8
{
  "message": "success"
}

//error
{
  "message": "Email does not exist"
}

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=delete&email=unsubscribe@sample.com

Response

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

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

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

<result>
   <message>Email does not exist</message>
</result>

Add Unsubscribes

Add unsubscribe email records to their account if they need to stop sending email messages to a specific recipient.
Parameter Required Requirements Description
user Yes Subuser must be registered under your account The subuser we are retrieving unsubscribes from
task Yes Must be set to add This will allow you to add an unsubscribe record for the specified subuser
email No Must be an unsubscribe record You must specify the unsubscribe record to add

Call

POST https://api.sendgrid.com/api/user.unsubscribes.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=add&email=unsubscribe@sample.com

Response

1
2
3
4
5
6
7
8
{
  "message": "success"
}

//error
{
  "message": "Email already exists"
}

Call

POST https://api.sendgrid.com/api/user.unsubscribes.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com&task=add&email=unsubscribe@sample.com

Response

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

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

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

<result>
   <message>Email already exists</message>
</result>