Get Available

List all of the available apps.

Note: The name entry is used in all the other API calls to identify a app. For a list of all the apps and parameters accesible with the Web API you can check the Filter Settings page.

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
[
  ...
  {
      "name": "bcc",
      "title": "BCC",
      "description": "Automatically BCC an address for every e-mail sent.",
      "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
10
<filters>
  ...
  <filter>
      <name>bcc</name>
      <title>BCC</title>
      <description>Automatically BCC an address for every e-mail sent.</description>
      <activated>0</activated>
  </filter>
   ...
</filters>

Activate App

Activate an app.

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
4
5
<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Deactivate App

Deactivate an app.

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
4
5
<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Setup App

Change application settings. 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&bcc=nick@sendgrid.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&bcc=nick@sendgrid.com

Response

1
2
3
4
5
<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Get App Settings

Get the Settings Of An App

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
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "message": "success",
  "settings": [
    {
      "bcc": "nick@sendgrid.com"
    }
  ]
}

//error
{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

//empty - This is returned if that filter has no settings or is not enabled.<
{
  "settings": null
}

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
4
5
6
7
8
9
10
11
12
13
14
15
<?xml version="1.0" encoding="ISO-8859-1"?>

<!-- success -->
<filter>
   <email>nick@sendgrid.com</email>
</filter>

<!-- error -->
<result>
   <message>error</message>
   <message>... error messages ...</message>
</result>

<!-- empty -->
<filter/>