Please see the Filter Settings page for a list of the required parameters for each app setting.

List

List all of the available appgs. Note: The name entry is used in all the other API calls to identify a app.
Parameter Required Requirements Description
task Yes Must be set to getavailable Retrieve Available Apps
user Yes Subuser must be registered under your account The subuser who we will update

Call

POST https://api.sendgrid.com/apiv2/customer.apps.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getavailable&user=example@example.com

Response

1
2
3
4
5
6
{
  "name": "twitter",
  "title": "Twitter",
  "description": "This plugin allows you to send an email message to twitter",
  "activated": false
}

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getavailable&user=example@example.com

Response

1
2
3
4
5
6
7
8
<filters>
  <filter>
    <name>twitter</name>
    <title>Twitter</title>
    <description>This plugin allows you to send an email message to twitter</description>
    <activated>0</activated>
  </filter>
</filters>

Activate App

Parameter Required Requirements Description
task Yes Must be set to activate Retrieve Available Apps
user Yes Subuser must be registered under your account The subuser who we will update

Call

POST https://api.sendgrid.com/apiv2/customer.apps.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=activate&user=example@example.com

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=activate&user=example@example.com

Response

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

Deactivate App

Parameter Required Requirements Description
task Yes Must be set to deactivate Retrieve Available Apps
user Yes Subuser must be registered under your account The subuser who we will update

Call

POST https://api.sendgrid.com/apiv2/customer.apps.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=deactivate&user=example@example.com

Response

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

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=deactivate&user=example@example.com

Response

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

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

Customize App

These API calls require that settings are passed using POST.

Call

POST https://api.sendgrid.com/apiv2/customer.apps.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=setup&user=example@example.com

Response

1
2
3
4
{"message":"success","settings":[{"field_name":"field_value"}]}

  //empty response
  {"settings":"null"}

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=setup&user=example@example.com

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?xml version="1.0" encoding="ISO-8859-1"?>

<filter>
   <field_name>field_value</field_name>
   ...
</filter>

<!-- error -->
<?xml version="1.0" encoding="ISO-8859-1"?>

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

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

Get Current Settings

Call

POST https://api.sendgrid.com/apiv2/customer.apps.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=getsettings&user=example@example.com

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": [
    {
      "field_name": "field_value"
    }
  ]
}

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

//empty response
{
  "settings": "null"
}

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=getsettings&user=example@example.com

Response

1
2
3
4
5
<!-- error -->
<result><message>error</message><message>... error messages ...</message></result>

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