On this page

Apps

(warning)

This documentation is for the SendGrid Web API v2

We will deprecate this version on February 10, 2025. To access all the latest features and upcoming developments, please see our v3 API. For assistance with transitioning, refer to our migration guide.

(information)

Info

Please see the Filter Settings page for a list of the required parameters for each app setting.

List

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

JSONXML

Call

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

Response

1[
2  {
3    "name": "clicktrack",
4    "title": "Click Tracking",
5    "description": "Overwrites every link to track every click in emails.",
6    "activated": true
7  },
8  {
9    "name": "subscriptiontrack",
10    "title": "Subscription Tracking",
11    "description": "Adds unsubscribe links to the bottom of the text and HTML emails. Future emails won't be delivered to unsubscribed users.",
12    "activated": false
13  },
14  {
15    "name": "opentrack",
16    "title": "Open Tracking",
17    "description": "Appends an invisible image to HTML emails to track emails that have been opened.",
18    "activated": true
19  }
20]

Note: The name entry is used in all the other API calls to identify an app.

Activate 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

JSONXML

Call

`POST`	`https://api.sendgrid.com/apiv2/customer.apps.json`
`POST` Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=clicktrack&task=activate&user=subuser_username`

Response

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

Deactivate App

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

JSONXML

Call

`POST`	`https://api.sendgrid.com/apiv2/customer.apps.json`
`POST` Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=clicktrack&task=deactivate&user=subuser_username`

Response

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

Setup App

These API calls require that settings are passed using POST.

(information)

Info

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

JSONXML

Call

`POST`	`https://api.sendgrid.com/apiv2/customer.apps.json`
`POST` Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&name=bcc&task=setup&email=test@example.com`

Response

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

Get Current Settings

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

JSONXML

Call

`POST`	`https://api.sendgrid.com/apiv2/customer.apps.json`
`POST` Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=clicktrack&task=getsettings&user=subuser_username`

Response

1{"settings":
2  {
3    "enable_text":"0"
4  }
5}