Apps

List

List all of the available apps. 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

1

https://sendgrid.com/apiv2/customer.apps.json?api_user=username&api_key=secureSecret&task=getavailable&user=example@example.com

Response: Success

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

1

https://sendgrid.com/apiv2/customer.apps.xml?api_user=username&api_key=secureSecret&task=getavailable&user=example@example.com

Response: Success

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

1

https://sendgrid.com/apiv2/customer.apps.json?api_user=username&api_key=secureSecret&name=twitter&task=activate&user=example@example.com

Response

1
2
3

{
  "message": "success"
}

Call

1

https://sendgrid.com/apiv2/customer.apps.xml?api_user=username&api_key=secureSecret&name=twitter&task=activate&user=example@example.com

Response: Success

1

    <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

1

https://sendgrid.com/apiv2/customer.apps.json?api_user=username&api_key=secureSecret&name=twitter&task=deactivate&user=example@example.com

Response

1
2
3

{
  "message": "success"
}

Call

1

https://sendgrid.com/apiv2/customer.apps.xml?api_user=username&api_key=secureSecret&name=twitter&task=deactivate&user=example@example.com

Response: Success

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

1

https://sendgrid.com/apiv2/customer.apps.json?api_user=username&api_key=secureSecret&name=twitter&task=setup&user=example@example.com

Response: Success

1
2

	{"message":"success","settings":[{"field_name":"field_value"}]}

Return - Empty

This is returned if that filter has no settings or is not enabled. 
1
2

	"settings":null

Call

1

https://sendgrid.com/apiv2/customer.apps.xml?api_user=username&api_key=secureSecret&name=twitter&task=setup&user=example@example.com

Response: Success

1
2
3
4
5
6

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

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

Response: Error

1
2
3
4
5
6

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

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

Return - Empty

This is returned if that filter has no settings or is not enabled. 
1

<filter></filter>

Get Current Settings

Call

1

https://sendgrid.com/apiv2/customer.apps.json?api_user=username&api_key=secureSecret&name=twitter&task=getsettings&user=example@example.com

Response: Success

1
2
3
4
5
6
7
8

{
  "message": "success",
  "settings": [
    {
      "field_name": "field_value"
    }
  ]
}

Response: Error

1
2
3
4
5
6

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

Return - Empty

This is returned if that filter has no settings or is not enabled. 
1
2
3

{
  "settings": null
}

Call

1

https://sendgrid.com/apiv2/customer.apps.xml?api_user=username&api_key=secureSecret&name=twitter&task=getsettings&user=example@example.com

Response: Success

1
2
3

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

Response: Error

1

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

Return - Empty

This is returned if that filter has no settings or is not enabled. 
1

<filter></filter>