These API requests apply account-wide, unlike the SMTP API which will change the status at the individual email message level.
List all of 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.
JSON
XML
GET
https://api.sendgrid.com/api/filter.getavailable.json
GET Data
api_user=apikey&api_key=your_sendgrid_api_key
[
{
"...": "..."
},
{
"name": "bcc",
"title": "BCC",
"description": "Automatically BCC an address for every e-mail sent from this account.",
"activated": false
},
{
"...": "..."
}
]
GET
https://api.sendgrid.com/api/filter.getavailable.xml
GET Data
api_user=apikey&api_key=your_sendgrid_api_key
<filters>
...
<filter>
<name>bcc</name>
<description>Automatically BCC an address for every e-mail sent.</description>
<activated>0</activated>
</filter>
...
</filters>
Activate an app for the entire Account.
URI Parameter
Required
Requirements
Description
name
true
The name of the app to activate.
JSON
XML
POST
https://api.sendgrid.com/api/filter.activate.json
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
POST
https://api.sendgrid.com/api/filter.activate.xml
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
<result>
<message>success</message>
</result>
Deactivate an app for the entire Account.
URI Parameter
Required
Requirements
Description
name
true
The name of the app to deactivate.
JSON
XML
POST
https://api.sendgrid.com/api/filter.deactivate.json
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
POST
https://api.sendgrid.com/api/filter.deactivate.xml
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
<result>
<message>success</message>
</result>
JSON
XML
POST
https://api.sendgrid.com/api/filter.setup.json
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc&email=example@example.com
POST
https://api.sendgrid.com/api/filter.setup.xml
POST Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc&email=example@example.com
<result>
<message>success</message>
</result>
Get the Settings Of An App
URI Parameter
Required
Requirements
Description
name
true
The name of the app for which to retrieve settings.
JSON
XML
GET
https://api.sendgrid.com/api/filter.getsettings.json
GET Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
{
"settings": [
{
"email": "example@example.com"
}
]
}
GET
https://api.sendgrid.com/api/filter.getsettings.xml
GET Data
api_user=apikey&api_key=your_sendgrid_api_key&name=bcc
<filter>
<email>nick@sendgrid.com</email>
</filter>