Skip to contentSkip to navigationSkip to topbar
On this page

API Key Permissions


(warning)

Warning

Twilio SendGrid API keys are 69 characters long. We are unable to make exceptions for third-party infrastructure that is unable to support a key of 69 characters.

API Keys can be used to authenticate the use of SendGrid's v3 API. API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access.

The following is a complete list of all possible permissions that you may assign to an API Key.


Admin API Key Permissions

admin-api-key-permissions page anchor

Below is a complete list of every API Key permission that should be given to an admin level API Key.

1
"scopes": [
2
"access_settings.activity.read",
3
"access_settings.whitelist.create",
4
"access_settings.whitelist.delete",
5
"access_settings.whitelist.read",
6
"access_settings.whitelist.update",
7
"alerts.create",
8
"alerts.delete",
9
"alerts.read",
10
"alerts.update",
11
"api_keys.create",
12
"api_keys.delete",
13
"api_keys.read",
14
"api_keys.update",
15
"asm.groups.create",
16
"asm.groups.delete",
17
"asm.groups.read",
18
"asm.groups.update",
19
"billing.create",
20
"billing.delete",
21
"billing.read",
22
"billing.update",
23
"browsers.stats.read",
24
"categories.create",
25
"categories.delete",
26
"categories.read",
27
"categories.stats.read",
28
"categories.stats.sums.read",
29
"categories.update",
30
"clients.desktop.stats.read",
31
"clients.phone.stats.read",
32
"clients.stats.read",
33
"clients.tablet.stats.read",
34
"clients.webmail.stats.read",
35
"credentials.create",
36
"credentials.delete",
37
"credentials.read",
38
"credentials.update",
39
"devices.stats.read",
40
"email_activity.read",
41
"geo.stats.read",
42
"ips.assigned.read",
43
"ips.pools.create",
44
"ips.pools.delete",
45
"ips.pools.ips.create",
46
"ips.pools.ips.delete",
47
"ips.pools.ips.read",
48
"ips.pools.ips.update",
49
"ips.pools.read",
50
"ips.pools.update",
51
"ips.read",
52
"ips.warmup.create",
53
"ips.warmup.delete",
54
"ips.warmup.read",
55
"ips.warmup.update",
56
"mail_settings.address_whitelist.read",
57
"mail_settings.address_whitelist.update",
58
"mail_settings.bcc.read",
59
"mail_settings.bcc.update",
60
"mail_settings.bounce_purge.read",
61
"mail_settings.bounce_purge.update",
62
"mail_settings.footer.read",
63
"mail_settings.footer.update",
64
"mail_settings.forward_bounce.read",
65
"mail_settings.forward_bounce.update",
66
"mail_settings.forward_spam.read",
67
"mail_settings.forward_spam.update",
68
"mail_settings.plain_content.read",
69
"mail_settings.plain_content.update",
70
"mail_settings.read",
71
"mail_settings.spam_check.read",
72
"mail_settings.spam_check.update",
73
"mail_settings.template.read",
74
"mail_settings.template.update",
75
"mail.batch.create",
76
"mail.batch.delete",
77
"mail.batch.read",
78
"mail.batch.update",
79
"mail.send",
80
"mailbox_providers.stats.read",
81
"marketing_campaigns.create",
82
"marketing_campaigns.delete",
83
"marketing_campaigns.read",
84
"marketing_campaigns.update",
85
"newsletter.create",
86
"newsletter.delete",
87
"newsletter.read",
88
"newsletter.update",
89
"partner_settings.new_relic.read",
90
"partner_settings.new_relic.update",
91
"partner_settings.read",
92
"partner_settings.sendwithus.read",
93
"partner_settings.sendwithus.update",
94
"stats.global.read",
95
"stats.read",
96
"subusers.create",
97
"subusers.credits.create",
98
"subusers.credits.delete",
99
"subusers.credits.read",
100
"subusers.credits.remaining.create",
101
"subusers.credits.remaining.delete",
102
"subusers.credits.remaining.read",
103
"subusers.credits.remaining.update",
104
"subusers.credits.update",
105
"subusers.delete",
106
"subusers.monitor.create",
107
"subusers.monitor.delete",
108
"subusers.monitor.read",
109
"subusers.monitor.update",
110
"subusers.read",
111
"subusers.reputations.read",
112
"subusers.stats.monthly.read",
113
"subusers.stats.read",
114
"subusers.stats.sums.read",
115
"subusers.summary.read",
116
"subusers.update",
117
"suppression.blocks.create",
118
"suppression.blocks.delete",
119
"suppression.blocks.read",
120
"suppression.blocks.update",
121
"suppression.bounces.create",
122
"suppression.bounces.delete",
123
"suppression.bounces.read",
124
"suppression.bounces.update",
125
"suppression.create",
126
"suppression.delete",
127
"suppression.invalid_emails.create",
128
"suppression.invalid_emails.delete",
129
"suppression.invalid_emails.read",
130
"suppression.invalid_emails.update",
131
"suppression.read",
132
"suppression.spam_reports.create",
133
"suppression.spam_reports.delete",
134
"suppression.spam_reports.read",
135
"suppression.spam_reports.update",
136
"suppression.unsubscribes.create",
137
"suppression.unsubscribes.delete",
138
"suppression.unsubscribes.read",
139
"suppression.unsubscribes.update",
140
"suppression.update",
141
"templates.create",
142
"templates.delete",
143
"templates.read",
144
"templates.update",
145
"templates.versions.activate.create",
146
"templates.versions.activate.delete",
147
"templates.versions.activate.read",
148
"templates.versions.activate.update",
149
"templates.versions.create",
150
"templates.versions.delete",
151
"templates.versions.read",
152
"templates.versions.update",
153
"tracking_settings.click.read",
154
"tracking_settings.click.update",
155
"tracking_settings.google_analytics.read",
156
"tracking_settings.google_analytics.update",
157
"tracking_settings.open.read",
158
"tracking_settings.open.update",
159
"tracking_settings.read",
160
"tracking_settings.subscription.read",
161
"tracking_settings.subscription.update",
162
"user.account.read",
163
"user.credits.read",
164
"user.email.create",
165
"user.email.delete",
166
"user.email.read",
167
"user.email.update",
168
"user.multifactor_authentication.create",
169
"user.multifactor_authentication.delete",
170
"user.multifactor_authentication.read",
171
"user.multifactor_authentication.update",
172
"user.password.read",
173
"user.password.update",
174
"user.profile.read",
175
"user.profile.update",
176
"user.scheduled_sends.create",
177
"user.scheduled_sends.delete",
178
"user.scheduled_sends.read",
179
"user.scheduled_sends.update",
180
"user.settings.enforced_tls.read",
181
"user.settings.enforced_tls.update",
182
"user.timezone.read",
183
"user.username.read",
184
"user.username.update",
185
"user.webhooks.event.settings.read",
186
"user.webhooks.event.settings.update",
187
"user.webhooks.event.test.create",
188
"user.webhooks.event.test.read",
189
"user.webhooks.event.test.update",
190
"user.webhooks.parse.settings.create",
191
"user.webhooks.parse.settings.delete",
192
"user.webhooks.parse.settings.read",
193
"user.webhooks.parse.settings.update",
194
"user.webhooks.parse.stats.read",
195
"whitelabel.create",
196
"whitelabel.delete",
197
"whitelabel.read",
198
"whitelabel.update"
199
]

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

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

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

Billing permissions are mutually exclusive from all other permissions. An API Key can have either Billing Permissions or any other set of Permissions but not both.

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

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

1
"scopes": [
2
"clients.desktop.stats.read",
3
"clients.phone.stats.read",
4
"clients.stats.read",
5
"clients.tablet.stats.read",
6
"clients.webmail.stats.read"
7
]

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

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

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

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

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

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

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

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

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

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

1
"scopes": [
2
"suppression.create",
3
"suppression.delete",
4
"suppression.read",
5
"suppression.update",
6
"suppression.bounces.create",
7
"suppression.bounces.read",
8
"suppression.bounces.update",
9
"suppression.bounces.delete",
10
"suppression.blocks.create",
11
"suppression.blocks.read",
12
"suppression.blocks.update",
13
"suppression.blocks.delete",
14
"suppression.invalid_emails.create",
15
"suppression.invalid_emails.read",
16
"suppression.invalid_emails.update",
17
"suppression.invalid_emails.delete",
18
"suppression.spam_reports.create",
19
"suppression.spam_reports.read",
20
"suppression.spam_reports.update",
21
"suppression.spam_reports.delete",
22
"suppression.unsubscribes.create",
23
"suppression.unsubscribes.read",
24
"suppression.unsubscribes.update",
25
"suppression.unsubscribes.delete"
26
]

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

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

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

1
"scopes": [
2
"user.account.read",
3
"user.credits.read",
4
"user.email.create",
5
"user.email.delete",
6
"user.email.read",
7
"user.email.update",
8
"user.multifactor_authentication.create",
9
"user.multifactor_authentication.delete",
10
"user.multifactor_authentication.read",
11
"user.multifactor_authentication.update",
12
"user.password.read",
13
"user.password.update",
14
"user.profile.read",
15
"user.profile.update",
16
"user.settings.enforced_tls.read",
17
"user.settings.enforced_tls.update",
18
"user.timezone.read",
19
"user.timezone.update",
20
"user.username.read",
21
"user.username.update"
22
]

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

Domain Authentication (formerly Whitelabel)

domain-authentication-formerly-whitelabel page anchor
1
"scopes": [
2
"whitelabel.create",
3
"whitelabel.delete",
4
"whitelabel.read",
5
"whitelabel.update"
6
]

Reverse DNS (formerly Whitelist)

reverse-dns-formerly-whitelist page anchor
1
"scopes": [
2
"access_settings.activity.read",
3
"access_settings.whitelist.create",
4
"access_settings.whitelist.delete",
5
"access_settings.whitelist.read",
6
"access_settings.whitelist.update"
7
]

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.