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.
These API requests apply account-wide, unlike the SMTP API which will change the status at the individual email message level.
List all the available apps.
Note: The name entry is used in all the other API calls to identify an app. For a list of all the apps and parameters accessible with the Web API you can check the Filter Settings page.
GET | https://api.sendgrid.com/api/filter.getavailable.json |
|---|---|
GET Data | api_user=apikey&api_key=your_sendgrid_api_key |
1[2{3"...": "..."4},5{6"name": "bcc",7"title": "BCC",8"description": "Automatically BCC an address for every email sent from this account.",9"activated": false10},11{12"...": "..."13}14]
Activate an app for the entire Account.
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| name | true | The name of the app to activate. |
Deactivate an app for the entire Account.
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| name | true | The name of the app to deactivate. |
Change application settings across the entire Account. Applications and their settings can be found in the Filter Settings documentation.
Get the Settings Of An App
| URI Parameter | Required | Requirements | Description |
|---|---|---|---|
| name | true | The name of the app for which to retrieve settings. |