Skip to contentSkip to navigationSkip to topbar
Rate this page:
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.


_199
"scopes": [
_199
"access_settings.activity.read",
_199
"access_settings.whitelist.create",
_199
"access_settings.whitelist.delete",
_199
"access_settings.whitelist.read",
_199
"access_settings.whitelist.update",
_199
"alerts.create",
_199
"alerts.delete",
_199
"alerts.read",
_199
"alerts.update",
_199
"api_keys.create",
_199
"api_keys.delete",
_199
"api_keys.read",
_199
"api_keys.update",
_199
"asm.groups.create",
_199
"asm.groups.delete",
_199
"asm.groups.read",
_199
"asm.groups.update",
_199
"billing.create",
_199
"billing.delete",
_199
"billing.read",
_199
"billing.update",
_199
"browsers.stats.read",
_199
"categories.create",
_199
"categories.delete",
_199
"categories.read",
_199
"categories.stats.read",
_199
"categories.stats.sums.read",
_199
"categories.update",
_199
"clients.desktop.stats.read",
_199
"clients.phone.stats.read",
_199
"clients.stats.read",
_199
"clients.tablet.stats.read",
_199
"clients.webmail.stats.read",
_199
"credentials.create",
_199
"credentials.delete",
_199
"credentials.read",
_199
"credentials.update",
_199
"devices.stats.read",
_199
"email_activity.read",
_199
"geo.stats.read",
_199
"ips.assigned.read",
_199
"ips.pools.create",
_199
"ips.pools.delete",
_199
"ips.pools.ips.create",
_199
"ips.pools.ips.delete",
_199
"ips.pools.ips.read",
_199
"ips.pools.ips.update",
_199
"ips.pools.read",
_199
"ips.pools.update",
_199
"ips.read",
_199
"ips.warmup.create",
_199
"ips.warmup.delete",
_199
"ips.warmup.read",
_199
"ips.warmup.update",
_199
"mail_settings.address_whitelist.read",
_199
"mail_settings.address_whitelist.update",
_199
"mail_settings.bcc.read",
_199
"mail_settings.bcc.update",
_199
"mail_settings.bounce_purge.read",
_199
"mail_settings.bounce_purge.update",
_199
"mail_settings.footer.read",
_199
"mail_settings.footer.update",
_199
"mail_settings.forward_bounce.read",
_199
"mail_settings.forward_bounce.update",
_199
"mail_settings.forward_spam.read",
_199
"mail_settings.forward_spam.update",
_199
"mail_settings.plain_content.read",
_199
"mail_settings.plain_content.update",
_199
"mail_settings.read",
_199
"mail_settings.spam_check.read",
_199
"mail_settings.spam_check.update",
_199
"mail_settings.template.read",
_199
"mail_settings.template.update",
_199
"mail.batch.create",
_199
"mail.batch.delete",
_199
"mail.batch.read",
_199
"mail.batch.update",
_199
"mail.send",
_199
"mailbox_providers.stats.read",
_199
"marketing_campaigns.create",
_199
"marketing_campaigns.delete",
_199
"marketing_campaigns.read",
_199
"marketing_campaigns.update",
_199
"newsletter.create",
_199
"newsletter.delete",
_199
"newsletter.read",
_199
"newsletter.update",
_199
"partner_settings.new_relic.read",
_199
"partner_settings.new_relic.update",
_199
"partner_settings.read",
_199
"partner_settings.sendwithus.read",
_199
"partner_settings.sendwithus.update",
_199
"stats.global.read",
_199
"stats.read",
_199
"subusers.create",
_199
"subusers.credits.create",
_199
"subusers.credits.delete",
_199
"subusers.credits.read",
_199
"subusers.credits.remaining.create",
_199
"subusers.credits.remaining.delete",
_199
"subusers.credits.remaining.read",
_199
"subusers.credits.remaining.update",
_199
"subusers.credits.update",
_199
"subusers.delete",
_199
"subusers.monitor.create",
_199
"subusers.monitor.delete",
_199
"subusers.monitor.read",
_199
"subusers.monitor.update",
_199
"subusers.read",
_199
"subusers.reputations.read",
_199
"subusers.stats.monthly.read",
_199
"subusers.stats.read",
_199
"subusers.stats.sums.read",
_199
"subusers.summary.read",
_199
"subusers.update",
_199
"suppression.blocks.create",
_199
"suppression.blocks.delete",
_199
"suppression.blocks.read",
_199
"suppression.blocks.update",
_199
"suppression.bounces.create",
_199
"suppression.bounces.delete",
_199
"suppression.bounces.read",
_199
"suppression.bounces.update",
_199
"suppression.create",
_199
"suppression.delete",
_199
"suppression.invalid_emails.create",
_199
"suppression.invalid_emails.delete",
_199
"suppression.invalid_emails.read",
_199
"suppression.invalid_emails.update",
_199
"suppression.read",
_199
"suppression.spam_reports.create",
_199
"suppression.spam_reports.delete",
_199
"suppression.spam_reports.read",
_199
"suppression.spam_reports.update",
_199
"suppression.unsubscribes.create",
_199
"suppression.unsubscribes.delete",
_199
"suppression.unsubscribes.read",
_199
"suppression.unsubscribes.update",
_199
"suppression.update",
_199
"templates.create",
_199
"templates.delete",
_199
"templates.read",
_199
"templates.update",
_199
"templates.versions.activate.create",
_199
"templates.versions.activate.delete",
_199
"templates.versions.activate.read",
_199
"templates.versions.activate.update",
_199
"templates.versions.create",
_199
"templates.versions.delete",
_199
"templates.versions.read",
_199
"templates.versions.update",
_199
"tracking_settings.click.read",
_199
"tracking_settings.click.update",
_199
"tracking_settings.google_analytics.read",
_199
"tracking_settings.google_analytics.update",
_199
"tracking_settings.open.read",
_199
"tracking_settings.open.update",
_199
"tracking_settings.read",
_199
"tracking_settings.subscription.read",
_199
"tracking_settings.subscription.update",
_199
"user.account.read",
_199
"user.credits.read",
_199
"user.email.create",
_199
"user.email.delete",
_199
"user.email.read",
_199
"user.email.update",
_199
"user.multifactor_authentication.create",
_199
"user.multifactor_authentication.delete",
_199
"user.multifactor_authentication.read",
_199
"user.multifactor_authentication.update",
_199
"user.password.read",
_199
"user.password.update",
_199
"user.profile.read",
_199
"user.profile.update",
_199
"user.scheduled_sends.create",
_199
"user.scheduled_sends.delete",
_199
"user.scheduled_sends.read",
_199
"user.scheduled_sends.update",
_199
"user.settings.enforced_tls.read",
_199
"user.settings.enforced_tls.update",
_199
"user.timezone.read",
_199
"user.username.read",
_199
"user.username.update",
_199
"user.webhooks.event.settings.read",
_199
"user.webhooks.event.settings.update",
_199
"user.webhooks.event.test.create",
_199
"user.webhooks.event.test.read",
_199
"user.webhooks.event.test.update",
_199
"user.webhooks.parse.settings.create",
_199
"user.webhooks.parse.settings.delete",
_199
"user.webhooks.parse.settings.read",
_199
"user.webhooks.parse.settings.update",
_199
"user.webhooks.parse.stats.read",
_199
"whitelabel.create",
_199
"whitelabel.delete",
_199
"whitelabel.read",
_199
"whitelabel.update"
_199
]



_10
"scopes": [
_10
"alerts.create",
_10
"alerts.delete",
_10
"alerts.read",
_10
"alerts.update"
_10
]



_10
"scopes": [
_10
"api_keys.create",
_10
"api_keys.delete",
_10
"api_keys.read",
_10
"api_keys.update"
_10
]



_10
"scopes": [
_10
"asm.groups.create",
_10
"asm.groups.delete",
_10
"asm.groups.read",
_10
"asm.groups.update"
_10
]


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.


_10
"scopes": [
_10
"billing.create",
_10
"billing.delete",
_10
"billing.read",
_10
"billing.update"
_10
]



_10
"scopes": [
_10
"categories.create",
_10
"categories.delete",
_10
"categories.read",
_10
"categories.update",
_10
"categories.stats.read",
_10
"categories.stats.sums.read"
_10
]



_10
"scopes": [
_10
"clients.desktop.stats.read",
_10
"clients.phone.stats.read",
_10
"clients.stats.read",
_10
"clients.tablet.stats.read",
_10
"clients.webmail.stats.read"
_10
]



_10
"scopes": [
_10
"credentials.create",
_10
"credentials.delete",
_10
"credentials.read",
_10
"credentials.update"
_10
]



_16
"scopes": [
_16
"ips.assigned.read",
_16
"ips.read",
_16
"ips.pools.create",
_16
"ips.pools.delete",
_16
"ips.pools.read",
_16
"ips.pools.update",
_16
"ips.pools.ips.create",
_16
"ips.pools.ips.delete",
_16
"ips.pools.ips.read",
_16
"ips.pools.ips.update",
_16
"ips.warmup.create",
_16
"ips.warmup.delete",
_16
"ips.warmup.read",
_16
"ips.warmup.update"
_16
]



_21
"scopes": [
_21
"mail_settings.address_whitelist.read",
_21
"mail_settings.address_whitelist.update",
_21
"mail_settings.bcc.read",
_21
"mail_settings.bcc.update",
_21
"mail_settings.bounce_purge.read",
_21
"mail_settings.bounce_purge.update",
_21
"mail_settings.footer.read",
_21
"mail_settings.footer.update",
_21
"mail_settings.forward_bounce.read",
_21
"mail_settings.forward_bounce.update",
_21
"mail_settings.forward_spam.read",
_21
"mail_settings.forward_spam.update",
_21
"mail_settings.plain_content.read",
_21
"mail_settings.plain_content.update",
_21
"mail_settings.read",
_21
"mail_settings.spam_check.read",
_21
"mail_settings.spam_check.update",
_21
"mail_settings.template.read",
_21
"mail_settings.template.update"
_21
]



_10
"scopes": [
_10
"mail.batch.create",
_10
"mail.batch.delete",
_10
"mail.batch.read",
_10
"mail.batch.update",
_10
"mail.send"
_10
]



_10
"scopes": [
_10
"marketing_campaigns.create",
_10
"marketing_campaigns.delete",
_10
"marketing_campaigns.read",
_10
"marketing_campaigns.update"
_10
]



_10
"scopes": [
_10
"newsletter.create",
_10
"newsletter.delete",
_10
"newsletter.read",
_10
"newsletter.update"
_10
]



_10
"scopes": [
_10
"partner_settings.new_relic.read",
_10
"partner_settings.new_relic.update",
_10
"partner_settings.read",
_10
"partner_settings.sendwithus.read",
_10
"partner_settings.sendwithus.update"
_10
]



_10
"scopes": [
_10
"user.scheduled_sends.create",
_10
"user.scheduled_sends.delete",
_10
"user.scheduled_sends.read",
_10
"user.scheduled_sends.update"
_10
]



_14
"scopes": [
_14
"email_activity.read",
_14
"stats.read",
_14
"stats.global.read",
_14
"browsers.stats.read",
_14
"devices.stats.read",
_14
"geo.stats.read",
_14
"mailbox_providers.stats.read",
_14
"clients.desktop.stats.read",
_14
"clients.phone.stats.read",
_14
"clients.stats.read",
_14
"clients.tablet.stats.read",
_14
"clients.webmail.stats.read"
_14
]



_23
"scopes": [
_23
"subusers.create",
_23
"subusers.delete",
_23
"subusers.read",
_23
"subusers.update",
_23
"subusers.credits.create",
_23
"subusers.credits.delete",
_23
"subusers.credits.read",
_23
"subusers.credits.update",
_23
"subusers.credits.remaining.create",
_23
"subusers.credits.remaining.delete",
_23
"subusers.credits.remaining.read",
_23
"subusers.credits.remaining.update",
_23
"subusers.monitor.create",
_23
"subusers.monitor.delete",
_23
"subusers.monitor.read",
_23
"subusers.monitor.update",
_23
"subusers.reputations.read",
_23
"subusers.stats.read",
_23
"subusers.stats.monthly.read",
_23
"subusers.stats.sums.read"
_23
"subusers.summary.read"
_23
]



_26
"scopes": [
_26
"suppression.create",
_26
"suppression.delete",
_26
"suppression.read",
_26
"suppression.update",
_26
"suppression.bounces.create",
_26
"suppression.bounces.read",
_26
"suppression.bounces.update",
_26
"suppression.bounces.delete",
_26
"suppression.blocks.create",
_26
"suppression.blocks.read",
_26
"suppression.blocks.update",
_26
"suppression.blocks.delete",
_26
"suppression.invalid_emails.create",
_26
"suppression.invalid_emails.read",
_26
"suppression.invalid_emails.update",
_26
"suppression.invalid_emails.delete",
_26
"suppression.spam_reports.create",
_26
"suppression.spam_reports.read",
_26
"suppression.spam_reports.update",
_26
"suppression.spam_reports.delete",
_26
"suppression.unsubscribes.create",
_26
"suppression.unsubscribes.read",
_26
"suppression.unsubscribes.update",
_26
"suppression.unsubscribes.delete"
_26
]



_10
"scopes": [
_10
"teammates.create",
_10
"teammates.read",
_10
"teammates.update",
_10
"teammates.delete"
_10
]



_14
"scopes": [
_14
"templates.create",
_14
"templates.delete",
_14
"templates.read",
_14
"templates.update",
_14
"templates.versions.activate.create",
_14
"templates.versions.activate.delete",
_14
"templates.versions.activate.read",
_14
"templates.versions.activate.update",
_14
"templates.versions.create",
_14
"templates.versions.delete",
_14
"templates.versions.read",
_14
"templates.versions.update"
_14
]



_11
"scopes": [
_11
"tracking_settings.click.read",
_11
"tracking_settings.click.update",
_11
"tracking_settings.google_analytics.read",
_11
"tracking_settings.google_analytics.update",
_11
"tracking_settings.open.read",
_11
"tracking_settings.open.update",
_11
"tracking_settings.read",
_11
"tracking_settings.subscription.read",
_11
"tracking_settings.subscription.update"
_11
]



_22
"scopes": [
_22
"user.account.read",
_22
"user.credits.read",
_22
"user.email.create",
_22
"user.email.delete",
_22
"user.email.read",
_22
"user.email.update",
_22
"user.multifactor_authentication.create",
_22
"user.multifactor_authentication.delete",
_22
"user.multifactor_authentication.read",
_22
"user.multifactor_authentication.update",
_22
"user.password.read",
_22
"user.password.update",
_22
"user.profile.read",
_22
"user.profile.update",
_22
"user.settings.enforced_tls.read",
_22
"user.settings.enforced_tls.update",
_22
"user.timezone.read",
_22
"user.timezone.update",
_22
"user.username.read",
_22
"user.username.update"
_22
]



_12
"scopes": [
_12
"user.webhooks.event.settings.read",
_12
"user.webhooks.event.settings.update",
_12
"user.webhooks.event.test.create",
_12
"user.webhooks.event.test.read",
_12
"user.webhooks.event.test.update",
_12
"user.webhooks.parse.settings.create",
_12
"user.webhooks.parse.settings.delete",
_12
"user.webhooks.parse.settings.read",
_12
"user.webhooks.parse.settings.update",
_12
"user.webhooks.parse.stats.read"
_12
]


Domain Authentication (formerly Whitelabel)

domain-authentication-formerly-whitelabel page anchor

_10
"scopes": [
_10
"whitelabel.create",
_10
"whitelabel.delete",
_10
"whitelabel.read",
_10
"whitelabel.update"
_10
]


Reverse DNS (formerly Whitelist)

reverse-dns-formerly-whitelist page anchor

_10
"scopes": [
_10
"access_settings.activity.read",
_10
"access_settings.whitelist.create",
_10
"access_settings.whitelist.delete",
_10
"access_settings.whitelist.read",
_10
"access_settings.whitelist.update"
_10
]


Rate this page: