These API requests are Account Wide settings, unlike the SMTP API which will change the status at the individual email message level.

Get Available

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.

Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/filter.getavailable.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  {
    "...": "..."
  },
  {
    "name": "bcc",
    "title": "BCC",
    "description": "Automatically BCC an address for every e-mail sent from this account.",
    "activated": false
  },
  {
    "...": "..."
  }
]

Call

GET https://api.sendgrid.com/api/filter.getavailable.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
4
5
6
7
8
9
<filters>
   ...
   <filter>
      <name>bcc</name>
      <description>Automatically BCC an address for every e-mail sent.</description>
      <activated>0</activated>
   </filter>
   ...
</filters>

Activate App

Activate an app for the entire Account.

Parameter Required Requirements Description
name true The name of the app to activate.
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/filter.activate.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/filter.activate.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
<result>
   <message>success</message>
</result>

Deactivate App

Deactivate an app for the entire Account.

Parameter Required Requirements Description
name true The name of the app to deactivate.
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/filter.deactivate.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/filter.deactivate.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
<result>
   <message>success</message>
</result>

Setup App

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

Call

POST https://api.sendgrid.com/api/filter.setup.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc&email=example@example.com

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/filter.setup.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc&email=example@example.com

Response

1
2
3
<result>
   <message>success</message>
</result>

Get App Settings

Get the Settings Of An App

Parameter Required Requirements Description
name true The name of the app for which to retrieve settings.
Parameter Value Requirements Description

Call

GET https://api.sendgrid.com/api/filter.getsettings.json?api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
4
5
6
7
{
  "settings": [
    {
      "email": "example@example.com"
    }
  ]
}

Call

GET https://api.sendgrid.com/api/filter.getsettings.xml?api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=bcc

Response

1
2
3
<filter>
   <email>nick@sendgrid.com</email>
</filter>