Menu

Expand

This documentation is for the SendGrid Web API v2

To access all the latest features and upcoming developments, please see our v3 API.

Apps

Setup your customers' app settings.

List

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

These are Reseller only APIs. For more information, see the Reseller Overview.

Call

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

Response

[
    {
        "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.manage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getavailable&method=apps&user=eexampexample@example.com

Response

<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

URI Parameter Required Requirements Description
task Yes Must be set to activate 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.manage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=newrelic&method=apps&task=activate&user=eexampexample@example.com

Response

{
  "message": "success"
}

Call

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

Response

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

Deactivate App

URI Parameter Required Requirements Description
task Yes Must be set to deactivate 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.manage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=newrelic&method=apps&task=deactivate&user=eexampexample@example.com

Response

{
  "message": "success"
}

Call

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

Response

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

Customize App

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

Call

POST https://api.sendgrid.com/apiv2/reseller.manage.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=newrelic&method=apps&task=setup&user=eexampexample@example.com&licence_key=1234567&enable_subusers=true

Response

{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/reseller.manage.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=newrelic&method=apps&task=setup&user=eexampexample@example.com&licence_key=1234567&enable_subusers=true

Response

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

Get Current Settings

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

Call

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

Response

{
    "settings": {
        "field_name": "field_value"
    }
}

Call

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

Response

<app>
   <field_name>field_value</field_name>
</app>

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.