Skip to contentSkip to navigationSkip to topbar
On this page

Filter Commands


(warning)

This documentation is for the SendGrid Web API v2

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.

(information)

Info

These API requests apply account-wide, unlike the SMTP API which will change the status at the individual email message level.


Get Available

get-available page anchor

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.

JSONXML

Call

GEThttps://api.sendgrid.com/api/filter.getavailable.json
GET Dataapi_user=apikey&api_key=your_sendgrid_api_key

Response

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": false
10
},
11
{
12
"...": "..."
13
}
14
]


Activate an app for the entire Account.

URI ParameterRequiredRequirementsDescription
nametrueThe name of the app to activate.
JSONXML
POSThttps://api.sendgrid.com/api/filter.activate.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&name=bcc
1
{
2
"message": "success"
3
}


Deactivate an app for the entire Account.

URI ParameterRequiredRequirementsDescription
nametrueThe name of the app to deactivate.
JSONXML
POSThttps://api.sendgrid.com/api/filter.deactivate.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&name=bcc
1
{
2
"message": "success"
3
}


Change application settings across the entire Account. Applications and their settings can be found in the Filter Settings documentation.

JSONXML
POSThttps://api.sendgrid.com/api/filter.setup.json
POST Dataapi_user=apikey&api_key=your_sendgrid_api_key&name=bcc&email=example@example.com
1
{
2
"message": "success"
3
}


Get the Settings Of An App

URI ParameterRequiredRequirementsDescription
nametrueThe name of the app for which to retrieve settings.
JSONXML
GEThttps://api.sendgrid.com/api/filter.getsettings.json
GET Dataapi_user=apikey&api_key=your_sendgrid_api_key&name=bcc
1
{
2
"settings": [
3
{
4
"email": "example@example.com"
5
}
6
]
7
}

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.