APIキーパーミッションリスト

APIキーはWeb API v3およびMailエンドポイントの認証に使用することができます。APIキーにはパーミッションもしくはスコープが割り当てられる場合があり、アクセス可能なエンドポイントに制限を課すことができます。APIキーのパーミッションに関する詳細については、Classroomページを参照してください。

以下にAPIキーに割り当てることのできる全てのパーミッションの一覧を示します。

本ページに示されるパーミッションに対応するAPIが全て公開されているわけではありません。

目次

Alerts

1
2
3
4
5
6
"scopes": [
  "alerts.create",
  "alerts.delete",
  "alerts.read",
  "alerts.update"
]

API Keys

1
2
3
4
5
6
"scopes": [
  "api_keys.create",
  "api_keys.delete",
  "api_keys.read",
  "api_keys.update"
]

ASM Groups

1
2
3
4
5
6
"scopes": [
  "asm.groups.create",
  "asm.groups.delete",
  "asm.groups.read",
  "asm.groups.update"
]

Categories

1
2
3
4
5
6
7
8
"scopes": [
  "categories.create",
  "categories.delete",
  "categories.read",
  "categories.update",
  "categories.stats.read",
  "categories.stats.sums.read"
]

Credentials

1
2
3
4
5
6
"scopes": [
  "credentials.create",
  "credentials.delete",
  "credentials.read",
  "credentials.update"
]

Stats

1
2
3
4
5
6
7
8
9
10
11
12
13
14
"scopes": [
  "email_activity.read",
  "stats.read",
  "stats.global.read",
  "browsers.stats.read",
  "devices.stats.read",
  "geo.stats.read",
  "mailbox_providers.stats.read",
  "clients.desktop.stats.read",
  "clients.phone.stats.read",
  "clients.stats.read",
  "clients.tablet.stats.read",
  "clients.webmail.stats.read"
]

IPs

1
2
3
4
5
6
7
8
9
10
11
12
13
"scopes": [
  "ips.assigned.read",
  "ips.read",
  "ips.pools.create",
  "ips.pools.delete",
  "ips.pools.read",
  "ips.pools.update",
  "ips.pools.ips.create",
  "ips.pools.ips.delete",
  "ips.warmup.create",
  "ips.warmup.delete",
  "ips.warmup.read"
]

Mail Settings

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
"scopes": [
  "mail_settings.address_whitelist.read",
  "mail_settings.address_whitelist.update",
  "mail_settings.bcc.read",
  "mail_settings.bcc.update",
  "mail_settings.bounce_purge.read",
  "mail_settings.bounce_purge.update",
  "mail_settings.footer.read",
  "mail_settings.footer.update",
  "mail_settings.forward_bounce.read",
  "mail_settings.forward_bounce.update",
  "mail_settings.forward_spam.read",
  "mail_settings.forward_spam.update",
  "mail_settings.plain_content.read",
  "mail_settings.plain_content.update",
  "mail_settings.read",
  "mail_settings.spam_check.read",
  "mail_settings.spam_check.update",
  "mail_settings.template.read",
  "mail_settings.template.update"
]

Mail

1
2
3
4
5
6
7
"scopes": [
  "mail.batch.create",
  "mail.batch.delete",
  "mail.batch.read",
  "mail.batch.update",
  "mail.send"
]

Marketing Campaigns

1
2
3
4
5
6
"scopes": [
  "marketing_campaigns.create",
  "marketing_campaigns.delete",
  "marketing_campaigns.read",
  "marketing_campaigns.update"
]

Partner Settings

1
2
3
4
5
6
7
"scopes": [
  "partner_settings.new_relic.read",
  "partner_settings.new_relic.update",
  "partner_settings.read",
  "partner_settings.sendwithus.read",
  "partner_settings.sendwithus.update"
]

Scheduled Sends

1
2
3
4
5
6
"scopes": [
  "user.scheduled_sends.create",
  "user.scheduled_sends.delete",
  "user.scheduled_sends.read",
  "user.scheduled_sends.update"
]

Subusers

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
"scopes": [
  "subusers.create",
  "subusers.delete",
  "subusers.read",
  "subusers.update",
  "subusers.credits.read",
  "subusers.credits.update",
  "subusers.credits.remaining.update",
  "subusers.monitor.create",
  "subusers.monitor.delete",
  "subusers.monitor.read",
  "subusers.monitor.update",
  "subusers.reputations.read",
  "subusers.stats.read",
  "subusers.stats.monthly.read",
  "subusers.stats.sums.read"
]

Suppressions

1
2
3
4
5
6
"scopes": [
  "suppressions.create",
  "suppressions.delete",
  "suppressions.read",
  "suppressions.update"
]

Templates

1
2
3
4
5
6
7
8
9
10
11
12
13
14
"scopes": [
  "templates.create",
  "templates.delete",
  "templates.read",
  "templates.update",
  "templates.versions.activate.create",
  "templates.versions.activate.delete",
  "templates.versions.activate.read",
  "templates.versions.activate.update",
  "templates.versions.create",
  "templates.versions.delete",
  "templates.versions.read",
  "templates.versions.update"
]

Tracking

1
2
3
4
5
6
7
8
9
10
11
"scopes": [
  "tracking_settings.click.read",
  "tracking_settings.click.update",
  "tracking_settings.google_analytics.read",
  "tracking_settings.google_analytics.update",
  "tracking_settings.open.read",
  "tracking_settings.open.update",
  "tracking_settings.read",
  "tracking_settings.subscription.read",
  "tracking_settings.subscription.update"
]

User Settings

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
"scopes": [
  "user.account.create",
  "user.account.delete",
  "user.account.read",
  "user.account.update",
  "user.credits.create",
  "user.credits.delete",
  "user.credits.read",
  "user.credits.update",
  "user.email.create",
  "user.email.delete",
  "user.email.read",
  "user.email.update",
  "user.multifactor_authentication.create",
  "user.multifactor_authentication.delete",
  "user.multifactor_authentication.read",
  "user.multifactor_authentication.update",
  "user.password.create",
  "user.password.delete",
  "user.password.read",
  "user.password.update",
  "user.profile.create",
  "user.profile.delete",
  "user.profile.read",
  "user.profile.update",
  "user.settings.enforced_tls.create",
  "user.settings.enforced_tls.delete",
  "user.settings.enforced_tls.read",
  "user.settings.enforced_tls.update",
  "user.timezone.create",
  "user.timezone.delete",
  "user.timezone.read",
  "user.timezone.update",
  "user.username.create",
  "user.username.delete",
  "user.username.read",
  "user.username.update"
]

Webhook

1
2
3
4
5
6
7
8
9
"scopes": [
  "user.webhooks.event.settings.read",
  "user.webhooks.event.settings.update",
  "user.webhooks.parse.settings.create",
  "user.webhooks.parse.settings.delete",
  "user.webhooks.parse.settings.read",
  "user.webhooks.parse.settings.update",
  "user.webhooks.parse.stats.read"
]

Whitelabel

1
2
3
4
5
6
"scopes": [
  "whitelabel.create",
  "whitelabel.delete",
  "whitelabel.read",
  "whitelabel.update"
]

Whitelist

1
2
3
4
5
"scopes": [
  "access_settings.whitelist.delete",
  "access_settings.whitelist.read",
  "access_settings.whitelist.update"
]