We will deprecate this version on February 10, 2025. To access all the latest features and upcoming developments, please see our v3 API. For assistance with transitioning, refer to our migration guide.
| 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 |
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 |
1[2{3"email": "emaieexampexample@example.com",4"created": "2009-06-01 19:41:39"5},6{7"email": "emaileexampexample@example.com",8"created": "2009-06-01 19:41:39"9}10]
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 unsubscribed address from |
| Yes | Address exists on the list | Address to remove from the Unsubscribe suppression list |
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 |
| Yes | Valid email address | Address to add to the Unsubscribe suppression list |