Retrieve Unsubscribes

URI Parameter Required Requirements Description
task Yes Must be set to get Task to retrieve unsubscribes for subuser
user Yes Subuser must be under your account Subuser to retrieve unsubscribes for
date No 0 or 1 Optional argument to retrieve the timestamps, in ISO-8601 format, Pacific Timezone: YYYY-MM-DD HH:MM:SS
Parameter Value Requirements Description

Call

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

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=subuser_username&task=get&date=1

Response

1
2
3
4
5
6
7
8
9
10
<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

SendGrid suppresses messages to unsubscribed addresses, but entries can be removed from the suppression list at any time if redelivery to an unsubscribed address is desired. Take care that the address should be redelivered to.

URI Parameter Required Requirements Description
task Yes Must be set to delete Task to remove unsubscribed address from subuser
user Yes Subuser must be under your account Subuser to remove unsubsribed address from
email Yes Address exists on the list Address to remove from the Unsubscribe suppression list
Parameter Value Requirements Description

Call

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

Response

1
2
3
{
  "message": "success"
}

Call

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

Response

1
2
3
<result>
   <message>success</message>
</result>

Add Unsubscribes

Manually add address to the Unsubscribe suppression list, to prevent delivery to the address.

URI Parameter Required Requirements Description
task Yes Must be set to add Task to add address to subuser Unsubscribe list
user Yes Subuser must be under your account Subuser to add Unsubscribed address
email Yes Valid email address Address to add to the Unsubscribe suppression list
Parameter Value Requirements Description

Call

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

Response

1
2
3
{
  "message": "success"
}

Call

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

Response

1
2
3
<result>
   <message>success</message>
</result>