Welcome to SendGrid's Web API v3! This API is RESTful, fully featured, easy to integrate with, and offers support in 7 different languages.
API Keys can be used to authenticate the use of SendGrid's v3 Web API, or the Mail API endpoint. API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissions, please visit our API Keys docs.
The following is a complete list of all possible permissions that you may assign to an API Key.
When updating a key to include user
or subuser
scopes, use basic authentication.
_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]
_10"scopes": [_10 "billing.create",_10 "billing.delete",_10 "billing.read",_10 "billing.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 "categories.create",_10 "categories.delete",_10 "categories.read",_10 "categories.update",_10 "categories.stats.read",_10 "categories.stats.sums.read"_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]
_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]
_14"scopes": [_14 "mail_settings.address_whitelist.read",_14 "mail_settings.address_whitelist.update",_14 "mail_settings.bounce_purge.read",_14 "mail_settings.bounce_purge.update",_14 "mail_settings.footer.read",_14 "mail_settings.footer.update",_14 "mail_settings.forward_bounce.read",_14 "mail_settings.forward_bounce.update",_14 "mail_settings.forward_spam.read",_14 "mail_settings.forward_spam.update",_14 "mail_settings.template.read",_14 "mail_settings.template.update"_14]
_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 "partner_settings.new_relic.read",_10 "partner_settings.new_relic.update",_10 "partner_settings.read"_10]
_10"scopes": [_10 "user.scheduled_sends.create",_10 "user.scheduled_sends.delete",_10 "user.scheduled_sends.read",_10 "user.scheduled_sends.update"_10]
_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]
_10"scopes": [_10 "whitelabel.create",_10 "whitelabel.delete",_10 "whitelabel.read",_10 "whitelabel.update"_10]
_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]
Below is a complete list of every API Key scope to be given to an admin level API Key.
_189"scopes": [_189 "access_settings.activity.read",_189 "access_settings.whitelist.create",_189 "access_settings.whitelist.delete",_189 "access_settings.whitelist.read",_189 "access_settings.whitelist.update",_189 "alerts.create",_189 "alerts.delete",_189 "alerts.read",_189 "alerts.update",_189 "api_keys.create",_189 "api_keys.delete",_189 "api_keys.read",_189 "api_keys.update",_189 "asm.groups.create",_189 "asm.groups.delete",_189 "asm.groups.read",_189 "asm.groups.update",_189 "billing.create",_189 "billing.delete",_189 "billing.read",_189 "billing.update",_189 "browsers.stats.read",_189 "categories.create",_189 "categories.delete",_189 "categories.read",_189 "categories.stats.read",_189 "categories.stats.sums.read",_189 "categories.update",_189 "clients.desktop.stats.read",_189 "clients.phone.stats.read",_189 "clients.stats.read",_189 "clients.tablet.stats.read",_189 "clients.webmail.stats.read",_189 "devices.stats.read",_189 "email_activity.read",_189 "geo.stats.read",_189 "ips.assigned.read",_189 "ips.pools.create",_189 "ips.pools.delete",_189 "ips.pools.ips.create",_189 "ips.pools.ips.delete",_189 "ips.pools.ips.read",_189 "ips.pools.ips.update",_189 "ips.pools.read",_189 "ips.pools.update",_189 "ips.read",_189 "ips.warmup.create",_189 "ips.warmup.delete",_189 "ips.warmup.read",_189 "ips.warmup.update",_189 "mail_settings.address_whitelist.read",_189 "mail_settings.address_whitelist.update",_189 "mail_settings.bounce_purge.read",_189 "mail_settings.bounce_purge.update",_189 "mail_settings.footer.read",_189 "mail_settings.footer.update",_189 "mail_settings.forward_bounce.read",_189 "mail_settings.forward_bounce.update",_189 "mail_settings.forward_spam.read",_189 "mail_settings.forward_spam.update",_189 "mail_settings.plain_content.read",_189 "mail_settings.plain_content.update",_189 "mail_settings.read",,_189 "mail_settings.template.read",_189 "mail_settings.template.update",_189 "mail.batch.create",_189 "mail.batch.delete",_189 "mail.batch.read",_189 "mail.batch.update",_189 "mail.send",_189 "mailbox_providers.stats.read",_189 "marketing_campaigns.create",_189 "marketing_campaigns.delete",_189 "marketing_campaigns.read",_189 "marketing_campaigns.update",_189 "partner_settings.new_relic.read",_189 "partner_settings.new_relic.update",_189 "partner_settings.read",_189 "stats.global.read",_189 "stats.read",_189 "subusers.create",_189 "subusers.credits.create",_189 "subusers.credits.delete",_189 "subusers.credits.read",_189 "subusers.credits.remaining.create",_189 "subusers.credits.remaining.delete",_189 "subusers.credits.remaining.read",_189 "subusers.credits.remaining.update",_189 "subusers.credits.update",_189 "subusers.delete",_189 "subusers.monitor.create",_189 "subusers.monitor.delete",_189 "subusers.monitor.read",_189 "subusers.monitor.update",_189 "subusers.read",_189 "subusers.reputations.read",_189 "subusers.stats.monthly.read",_189 "subusers.stats.read",_189 "subusers.stats.sums.read",_189 "subusers.summary.read",_189 "subusers.update",_189 "suppression.blocks.create",_189 "suppression.blocks.delete",_189 "suppression.blocks.read",_189 "suppression.blocks.update",_189 "suppression.bounces.create",_189 "suppression.bounces.delete",_189 "suppression.bounces.read",_189 "suppression.bounces.update",_189 "suppression.create",_189 "suppression.delete",_189 "suppression.invalid_emails.create",_189 "suppression.invalid_emails.delete",_189 "suppression.invalid_emails.read",_189 "suppression.invalid_emails.update",_189 "suppression.read",_189 "suppression.spam_reports.create",_189 "suppression.spam_reports.delete",_189 "suppression.spam_reports.read",_189 "suppression.spam_reports.update",_189 "suppression.unsubscribes.create",_189 "suppression.unsubscribes.delete",_189 "suppression.unsubscribes.read",_189 "suppression.unsubscribes.update",_189 "suppression.update",_189 "teammates.create",_189 "teammates.read",_189 "teammates.update",_189 "teammates.delete",_189 "templates.create",_189 "templates.delete",_189 "templates.read",_189 "templates.update",_189 "templates.versions.activate.create",_189 "templates.versions.activate.delete",_189 "templates.versions.activate.read",_189 "templates.versions.activate.update",_189 "templates.versions.create",_189 "templates.versions.delete",_189 "templates.versions.read",_189 "templates.versions.update",_189 "tracking_settings.click.read",_189 "tracking_settings.click.update",_189 "tracking_settings.google_analytics.read",_189 "tracking_settings.google_analytics.update",_189 "tracking_settings.open.read",_189 "tracking_settings.open.update",_189 "tracking_settings.read",_189 "tracking_settings.subscription.read",_189 "tracking_settings.subscription.update",_189 "user.account.read",_189 "user.credits.read",_189 "user.email.create",_189 "user.email.delete",_189 "user.email.read",_189 "user.email.update",_189 "user.multifactor_authentication.create",_189 "user.multifactor_authentication.delete",_189 "user.multifactor_authentication.read",_189 "user.multifactor_authentication.update",_189 "user.password.read",_189 "user.password.update",_189 "user.profile.read",_189 "user.profile.update",_189 "user.scheduled_sends.create",_189 "user.scheduled_sends.delete",_189 "user.scheduled_sends.read",_189 "user.scheduled_sends.update",_189 "user.settings.enforced_tls.read",_189 "user.settings.enforced_tls.update",_189 "user.timezone.read",_189 "user.username.read",_189 "user.username.update",_189 "user.webhooks.event.settings.read",_189 "user.webhooks.event.settings.update",_189 "user.webhooks.event.test.create",_189 "user.webhooks.event.test.read",_189 "user.webhooks.event.test.update",_189 "user.webhooks.parse.settings.create",_189 "user.webhooks.parse.settings.delete",_189 "user.webhooks.parse.settings.read",_189 "user.webhooks.parse.settings.update",_189 "user.webhooks.parse.stats.read",_189 "whitelabel.create",_189 "whitelabel.delete",_189 "whitelabel.read",_189 "whitelabel.update"_189]