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
method Yes Must be set to apps Allows you to access apps functionality
Parameter Value Requirements Description

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
    {
        "name": "gravatar",
        "title": "Gravatar",
        "description": "Appends your gravatar to each HTML email.",
        "activated": false
    },
    {
        "name": "clicktrack",
        "title": "Click Tracking",
        "description": "Overwrites every link to track every click in emails.",
        "activated": false
    }
]

Call

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

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<apps>
    <app>
        <name>gravatar</name>
        <title>Gravatar</title>
        <description>Appends your gravatar to each HTML email.</description>
        <activated>0</activated>
    </app>
    <app>
        <name>clicktrack</name>
        <title>Click Tracking</title>
        <description>Overwrites every link to track every click in emails.</description>
        <activated>0</activated>
    </app>
</apps>

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
method Yes Must be set to apps Allows you to access apps functionality
name Yes Must be set to name of the app Name is returned in the List API call above
Parameter Value Requirements Description

Call

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

Response

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

Call

POST https://api.sendgrid.com/apiv2/reseller.subuserManage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=newrelic&method=apps&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 Customer subuser must be registered under your account The customer subuser who we will update
method Yes Must be set to apps Allows you to access apps functionality
name Yes Must be set to name of the app Name is returned in the List API call above
Parameter Value Requirements Description

Call

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

Response

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

Call

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

Response

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

Customize App

These API calls require that settings are passed using POST.

Parameter Required Requirements Description
task Yes Must be set to setup Retrieve Available Apps
user Yes Customer must be registered under your account The customer who we will update
method Yes Must be set to apps Allows you to access apps functionality
name Yes Must be set to name of the app Name is returned in the List API call above
field_name Yes Must be set to a setting field name The fields required for each app to work properly

Call

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

Response

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

Call

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

Response

1
2
3
4
<filter>
   <field_name>field_value</field_name>
   ...
</filter>

Get Current Settings

Parameter Required Requirements Description
task Yes Must be set to getsettings Retrieve Available Apps
user Yes Customer must be registered under your account The customer who we will update
method Yes Must be set to apps Allows you to access apps functionality
name Yes Must be set to name of the app Name is returned in the List API call above

Call

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

Response

1
2
3
4
5
{
  "settings": {
      "field_name": "field_value"
    }
}

Call

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

Response

1
2
3
4
<app>
   <field_name>field_value</field_name>
   ...
</app>