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 Customer subuser must be registered under
your account		 The customer subuser who we will update

XML API Request

https://sendgrid.com/api/distributor.manageSubuser.xml?api_user=username&api_key=secureSecret&task=getavailable&method=apps&user=example@example.com

Return – Success

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

JSON API Request

https://sendgrid.com/api/distributor.manageSubuser.json?api_user=username&api_key=secureSecret&task=getavailable&method=apps&user=example@example.com

Return – Success

[{"name":"twitter","title":"Twitter","description":"This plugin allows you to send an email message to twitter","activated":false}, ... ]

Activate App

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

XML API Request

https://sendgrid.com/api/distributor.manageSubuser.xml?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=activate&user=example@example.com

Return – Success

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

JSON API Request

https://sendgrid.com/api/distributor.manageSubuser.json?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=activate&user=example@example.com

Return

{"message":"success"}

Deactivate App

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

XML API Request

https://sendgrid.com/api/distributor.manageSubuser.xml?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=deactivate&user=example@example.com

Return – Success

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

JSON API Request

https://sendgrid.com/api/distributor.manageSubuser.json?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=deactivate&user=example@example.com

Return

{"message":"success"}

Customize App

These API calls require that settings are passed using POST.

XML API Request

https://sendgrid.com/api/distributor.manageSubuser.xml?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=setup&user=example@example.com

Return – Success

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

Return – Error

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

Return – Empty

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

<filter></filter>

JSON API Request

https://sendgrid.com/api/distributor.manageSubuser.json?api_user=username&api_key=secureSecret&name=twitter&method=apps&task=setup&user=example@example.com

Return – Success

{"message":"success","settings":{"field_name":"field_value”}}

Return – Empty

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

{"settings":null}

Get Current Settings

XML API Request

https://sendgrid.com/api/distributor.manageSubuser.xml?api_user=username&api_key=secureSecret&name=twitter&task=getsettings&user=example@example.com&method=apps

Return – Success

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

Return – Error

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

Return – Empty

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

<filter></filter>

JSON API Request

https://sendgrid.com/api/distributor.manageSubuser.json?api_user=username&api_key=secureSecret&name=twitter&task=getsettings&user=example@example.com&method=apps

Return – Success

{"message":"success","settings":{"field_name":"field_value”}}

Return – Error

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

Return – Empty

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

{"settings":null}