---

layout: page

weight: 0

title: Apps

navigation:

show: true

---

{% info %}

Please see the <a href='{{root_url}}/API_Reference/Web_API/filter_settings.html'>Filter Settings</a> page for a list of the required parameters for each app setting.

{% endinfo %}

{% anchor h2 %}

List

{% endanchor %}

List all of the available appgs.

Note: The

<em>name</em>

entry is used in all the other API calls to identify a app.

<table class="table table-bordered table-striped"><tbody>

<tr>

<td>Parameter</td>

<td>Required</td>

<td>Requirements</td>

<td>Description</td>

</tr>

<tr>

<td>task</td>

<td>Yes</td>

<td>Must be set to

<em>getavailable</em>

</td>

<td>Retrieve Available Apps</td>

</tr>

<tr>

<td>user</td>

<td>Yes</td>

<td>Subuser must be registered under your account</td>

<td>The subuser who we will update</td>

</tr>

</tbody></table>

{% apiexample list POST https://api.sendgrid.com/apiv2/customer.apps api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getavailable&user=example@example.com %}

{% response json %}

{

"name": "twitter",

"title": "Twitter",

"description": "This plugin allows you to send an email message to twitter",

"activated": false

}

{% endresponse %}

{% response xml %}

<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>

{% endresponse %}

{% endapiexample %}

<hr/>

{% anchor h2 %}

Activate App

{% endanchor %}

<table class="table table-bordered table-striped"><tbody>

<tr>

<td>Parameter</td>

<td>Required</td>

<td>Requirements</td>

<td>Description</td>

</tr>

<tr>

<td>task</td>

<td>Yes</td>

<td>Must be set to

<em>activate</em>

</td>

<td>Retrieve Available Apps</td>

</tr>

<tr>

<td>user</td>

<td>Yes</td>

<td>Subuser must be registered under your account</td>

<td>The subuser who we will update</td>

</tr>

</tbody></table>

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

{% response json %}

{

"message": "success"

}

{% endresponse %}

{% response xml %}

<result>

<message>success</message>

</result>

{% endresponse %}

{% endapiexample %}

<hr/>

{% anchor h2 %}

Deactivate App

{% endanchor %}

<table class="table table-bordered table-striped"><tbody>

<tr>

<td>Parameter</td>

<td>Required</td>

<td>Requirements</td>

<td>Description</td>

</tr>

<tr>

<td>task</td>

<td>Yes</td>

<td>Must be set to

<em>deactivate</em>

</td>

<td>Retrieve Available Apps</td>

</tr>

<tr>

<td>user</td>

<td>Yes</td>

<td>Subuser must be registered under your account</td>

<td>The subuser who we will update</td>

</tr>

</tbody></table>

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

{% response json %}

{

"message": "success"

}

{% endresponse %}

{% response xml %}

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

<result>

<message>success</message>

</result>

{% endresponse %}

{% endapiexample %}

<hr/>

{% anchor h2 %}

Customize App

{% endanchor %}

These API calls require that settings are passed using POST.

{% apiexample customize POST https://api.sendgrid.com/apiv2/customer.apps api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=setup&user=example@example.com %}

{% response json %}

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

//empty response

{"settings":"null"}

{% endresponse %}

{% response xml %}

<?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>

{% endresponse %}

{% endapiexample %}

<hr/>

{% anchor h2 %}

Get Current Settings

{% endanchor %}

{% apiexample settings POST https://api.sendgrid.com/apiv2/customer.apps api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=getsettings&user=example@example.com %}

{% response json %}

{

"message": "success",

"settings": [

{

"field_name": "field_value"

}

]

}

//error

{

"message": "error",

"errors": [

"...error messages..."

]

}

//empty response

{

"settings": "null"

}

{% endresponse %}

{% response xml %}

<!-- error -->

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

<!-- empty response -->

<filter></filter>

{% endresponse %}

{% endapiexample %}