Customer Unsubscribes

Manage your customers' unsubscribes.

Retrieve Unsubscribes

Note that you can use either the days parameter or the start_date and end_date parameters.

These are Reseller only APIs. For more information, see Reseller Overview.

URI Parameter	Required	Requirements	Description
user	Yes	Customer must be registered under your account	The customer we are retrieving unsubscribes from
task	Yes	Must be set to `get`	This will allow you to retrieve the unsubscribes for the specified customer
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`
method	Yes	Must be set to `unsubscribes`	Allows you to access unsubscribe functionality

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=unsubscribes&user=eexampexample@example.com&task=get&date=1`

Response

[
  {
    "email": "emaieexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  },
  {
    "email": "emaileexampexample@example.com",
    "created": "2009-06-01 19:41:39"
  }
]

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manage.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=unsubscribes&user=eexampexample@example.com&task=get&date=1`

Response

<unsubscribes>
   <unsubscribe>
      <email>emaieexampexample@example.com</email>
      <created>2009-06-10 12:40:30</created>
   </unsubscribe>
   <unsubscribe>
      <email>emaileexampexample@example.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.

URI Parameter	Required	Requirements	Description
user	Yes	Customer must be registered under your account	The customer we are retrieving unsubscribes from
task	Yes	Must be set to `delete`	This will allow you to delete an unsubscribe record for the specified customer
method	Yes	Must be set to `unsubscribes`	Allows you to access unsubscribe functionality
email	No	Must be an unsubscribe record	You must specify the unsubscribe record to remove

Call

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

Response

{
  "message": "success"
}

Call

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

Response

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

Add Unsubscribes

Add unsubscribe email records to a customer's account if they need to stop sending email messages to a specific recipient.

URI Parameter	Required	Requirements	Description
user	Yes	Customer must be registered under your account	The customer we are retrieving unsubscribes from
task	Yes	Must be set to `add`	This will allow you to add an unsubscribe record for the specified customer
method	Yes	Must be set to `unsubscribes`	Allows you to access unsubscribe functionality
email	No	Must be an unsubscribe record	You must specify the unsubscribe record to add

Call

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

Response

{
  "message": "success"
}

Call

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

Response

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

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.

This documentation is for the SendGrid Web API v2

Need some help?

Thank you for your feedback!

Thanks for your feedback!