To access all the latest features and upcoming developments, please see our v3 API.
Please see the Filter Settings page for a list of the required parameters for each app setting.
List all the available apps available for the subuser.
URI Parameter | Required | Requirements | Description |
---|---|---|---|
task | Yes | Must be set to getAvailable | Task to retrieve available apps for the subuser |
user | Yes | Subuser must be under your account | The subuser being queried |
POST | https://api.sendgrid.com/apiv2/customer.apps.json |
---|---|
POST Data | api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getAvailable&user=subuser_username |
_20[_20 {_20 "name": "clicktrack",_20 "title": "Click Tracking",_20 "description": "Overwrites every link to track every click in emails.",_20 "activated": true_20 },_20 {_20 "name": "subscriptiontrack",_20 "title": "Subscription Tracking",_20 "description": "Adds unsubscribe links to the bottom of the text and HTML emails. Future emails won't be delivered to unsubscribed users.",_20 "activated": false_20 },_20 {_20 "name": "opentrack",_20 "title": "Open Tracking",_20 "description": "Appends an invisible image to HTML emails to track emails that have been opened.",_20 "activated": true_20 }_20]
Note: The name
entry is used in all the other API calls to identify an app.
Activate an app on a subuser.
URI Parameter | Required | Requirements | Description |
---|---|---|---|
task | Yes | Must be set to activate | Task to activate an app |
user | Yes | Subuser must be under your account | The subuser to activate the app on |
name | Yes | Must be a supported app | The app to activate |
Deactivate an app on a subuser.
URI Parameter | Required | Requirements | Description |
---|---|---|---|
task | Yes | Must be set to deactivate | Deactivate an app |
user | Yes | Subuser must be under your account | The subuser to deactivate the app on |
name | Yes | Must be a supported app | The app to deactivate |
These API calls require that settings are passed using POST
.
Refer to Filter Settings for the required arguments for each app.
URI Parameter | Required | Requirements | Description |
---|---|---|---|
task | Yes | Must be set to setup | Task to setup an app |
user | Yes | Subuser must be under your account | The subuser to setup the app on |
name | Yes | Must be a supported app | The app to setup |
Get the settings for a subuser's app.
URI Parameter | Required | Requirements | Description |
---|---|---|---|
task | Yes | Must be set to getsettings | Task to retrieve the settings for the app |
user | Yes | Subuser must be under your account | The subuser get the app settings for |
name | Yes | Must be a supported app | The app to retrieve settings of |