Apps

各Appに必要なパラメータについてはFilter Settingsを参照してください。

List

利用可能な全てのAppリストを取得します。

URI引数 必須 条件 説明
task Yes getAvailableを指定します 利用可能なAppの一覧を取得します
user Yes サブユーザは親アカウント配下に登録されている必要があります 対象サブユーザ
Parameter Value Requirements Description

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

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&task=getAvailable&user=subuser_username

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<apps>
  <app>
    <name>clicktrack</name>
    <title>Click Tracking</title>
    <description>Overwrites every link to track every click in emails.</description>
    <activated>1</activated>
  </app>
  <app>
    <name>subscriptiontrack</name>
    <title>Subscription Tracking</title>
    <description>Adds unsubscribe links to the bottom of the text and HTML emails.  Future emails won't be delivered to unsubscribed users.</description>
    <activated>0</activated>
  </app>
  <app>
    <name>opentrack</name>
    <title>Open Tracking</title>
    <description>Appends an invisible image to HTML emails to track emails that have been opened.</description>
    <activated>1</activated>
  </app>
</apps>
注: nameエントリは他の全てのAPIでAppを識別するために使用されます。

Activate App

サブユーザのAppを有効化します。

URI引数 必須 条件 説明
task Yes activateを指定します Appを有効化します
user Yes サブユーザは親アカウント配下に登録されている必要があります 対象サブユーザ
name Yes サポートされているAppである必要があります 有効化するApp
Parameter Value Requirements Description

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
3
{
  "message": "success"
}

Call

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

Response

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

Deactivate App

サブユーザのAppを無効化します。

URI引数 必須 条件 説明
task Yes deactivateを指定します Appを無効化します
user Yes サブユーザは親アカウント配下に登録されている必要があります 対象サブユーザ
name Yes サポートされているAppである必要があります 無効化するApp
Parameter Value Requirements Description

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
3
{
  "message": "success"
}

Call

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

Response

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

Setup App

このAPIはPOSTを使って設定を送信する必要があります。

各Appに必要なパラメータについてはFilter Settingsを参照してください。

URI引数 必須 条件 説明
task Yes setupを指定します Appをセットアップします
user Yes サブユーザは親アカウント配下に登録されている必要があります 対象サブユーザ
name Yes サポートされているAppである必要があります セットアップするApp
Parameter Value Requirements Description

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
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.apps.xml
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
3
<result>
   <message>success</message>
</result>

Get Current Settings

サブユーザのAppの設定を取得します。

URI引数 必須 条件 説明
task Yes getsettingsを指定します App設定を取得します
user Yes サブユーザは親アカウント配下に登録されている必要があります 対象サブユーザ
name Yes サポートされているAppである必要があります 設定を取得するApp
Parameter Value Requirements Description

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
2
3
4
5
{"settings":
  {
    "enable_text":"0"
  }
}

Call

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

Response

1
2
3
<app>
  <enable_text>1</enable_text>
</app>