Setup Customer Subusers' Apps.
List all of the available apps.
Note: The name
entry is used in all the other API calls to identify an app.
URI 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
JSON
XML
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
[
{
"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
}
]
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
<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>
URI 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
JSON
XML
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
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
<result>
<message>success</message>
</result>
URI 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
JSON
XML
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
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
<result>
<message>success</message>
</result>
These API calls require that settings are passed using POST.
URI 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
JSON
XML
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
{
"message": "success",
"settings": [
{
"field_name": "field_value"
}
]
}
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
<filter>
<field_name>field_value</field_name>
...
</filter>
URI 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
JSON
XML
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
{
"settings": {
"field_name": "field_value"
}
}
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
<app>
<field_name>field_value</field_name>
...
</app>