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 Call

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

Response: Success

1
2
3
4
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 Call

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

Response: Success

1
{"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 Call

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

Response: Success

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

JSON Call

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

Response

1
2
3
{
  "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 Call

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

Response: Success

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

JSON Call

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

Response

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

Customize App

These API calls require that settings are passed using POST.

XML Call

POST https://api.sendgrid.com/api/distributor.manageSubuser.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&method=apps&task=setup&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

JSON Call

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

Response: Success

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

Return - Empty

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

1
"settings":null}

Get Current Settings

XML Call

POST https://api.sendgrid.com/api/distributor.manageSubuser.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=getsettings&user=example@example.com&method=app

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

JSON Call

POST https://api.sendgrid.com/api/distributor.manageSubuser.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=twitter&task=getsettings&user=example@example.com&method=app

Response: Success

1
{"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
"settings":null