Last active
March 29, 2017 17:25
-
-
Save derrickreimer/fe666d7a14e0d9783c9f83e0233c6fe0 to your computer and use it in GitHub Desktop.
All available SendGrid API scopes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Current as of March 31, 2016 | |
# | |
# There is an incomplete list of permissions in the docs: | |
# https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/api_key_permissions_list.html | |
# | |
# The rest have been filled in from the scopes endpoint: | |
# https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/api_keys_permissions.html | |
# Alerts | |
- alerts.create # create new alerts | |
- alerts.delete # delete existing alerts | |
- alerts.read # retrieve alerts | |
- alerts.update # update existing alerts | |
# API Keys | |
- api_keys.create # create new api keys | |
- api_keys.delete # delete existing api keys | |
- api_keys.read # retrieve api keys | |
- api_keys.update # update existing api keys | |
# ASM Groups | |
- asm.groups.create # create new unsubscribe groups | |
- asm.groups.delete # delete existing unsubscribe groups | |
- asm.groups.read # retrieve unsubscribe groups | |
- asm.groups.update # update existing unsubscribe groups | |
- asm.groups.suppressions.create | |
- asm.groups.suppressions.read | |
- asm.groups.suppressions.update | |
- asm.groups.suppressions.delete | |
- asm.suppressions.global.create | |
- asm.suppressions.global.read | |
- asm.suppressions.global.update | |
- asm.suppressions.global.delete | |
# Billing | |
- billing.delete # perform a cancellation of the account | |
- billing.read # retrieve billing information and invoices | |
- billing.update # modify billing information, including the ability to perform package changes | |
- billing.create | |
# Categories | |
- categories.create # create a new category | |
- categories.delete # delete an existing category | |
- categories.read # retrieve categories | |
- categories.update # update an existing category | |
- categories.stats.read # retrieve category stats | |
- categories.stats.sums.read # retrieve summed category stats | |
# Clients | |
- clients.desktop.stats.read # retrieve desktop client stats | |
- clients.phone.stats.read # retrieve phone client stats | |
- clients.stats.read # retrieve client stats | |
- clients.tablet.stats.read # retrieve tablet client stats | |
- clients.webmail.stats.read # retrieve webmail client stats | |
# Credentials | |
- credentials.create # create new credentials | |
- credentials.delete # delete existing credentials | |
- credentials.read # retrieve credentials | |
- credentials.update # update existing credentials | |
# Stats | |
- email_activity.read # retrieve email activity | |
- stats.read # retrieve stats | |
- stats.global.read # retrieve global stats | |
- browsers.stats.read # retrieve browser stats | |
- devices.stats.read # retrieve device stats | |
- geo.stats.read # retrieve geographical stats | |
- mailbox_providers.stats.read # retrieve stats for mailbox providers | |
# IPs | |
- ips.assigned.read # retrieve assigned IPs | |
- ips.read # retrieve all IPs | |
- ips.pools.create # create new IP pools | |
- ips.pools.delete # delete an existing IP pool | |
- ips.pools.read # retrieve IP pools | |
- ips.pools.update # update existing IP pools | |
- ips.pools.ips.create # add an IP to an IP pool | |
- ips.pools.ips.delete # remove an IP from an IP pool | |
- ips.warmup.create # add IPs to the warmup group | |
- ips.warmup.delete # remove an IP from the warmup group | |
- ips.warmup.read # retrieve IPs in the warmup pool | |
- ips.warmup.update | |
- ips.pools.ips.read | |
- ips.pools.ips.update | |
# Mail Settings | |
- mail_settings.address_whitelist.read # retrieve settings for address whitelisting | |
- mail_settings.address_whitelist.update # modify settings for address whitelisting | |
- mail_settings.bcc.create | |
- mail_settings.bcc.read # retrieve settings for bcc | |
- mail_settings.bcc.update # modify settings for bcc | |
- mail_settings.bounce_purge.read # retrieve settings for bounce purges | |
- mail_settings.bounce_purge.update # modify settings for bounce purges | |
- mail_settings.footer.read # retrieve settings for email footers | |
- mail_settings.footer.update # modify settings for email footers | |
- mail_settings.forward_bounce.read # retrieve settings for bounce forwarding | |
- mail_settings.forward_bounce.update # modify settings for bounce forwarding | |
- mail_settings.forward_spam.read # retrieve settings for spam forwarding | |
- mail_settings.forward_spam.update # modify settings for spam forwarding | |
- mail_settings.plain_content.read # retrieve settings for plain text conversion | |
- mail_settings.plain_content.update # modify settings for plain text conversion | |
- mail_settings.read # retrieve a list of the available mail settings | |
- mail_settings.spam_check.read # retrieve settings for spam checking | |
- mail_settings.spam_check.update # modify settings for spam checking | |
- mail_settings.template.read # retrieve settings for templating | |
- mail_settings.template.update # modify settings for templating | |
- mail_settings.bcc.delete | |
- mail_settings.address_whitelist.create | |
- mail_settings.address_whitelist.delete | |
- mail_settings.footer.create | |
- mail_settings.footer.delete | |
- mail_settings.forward_spam.create | |
- mail_settings.forward_spam.delete | |
- mail_settings.plain_content.create | |
- mail_settings.plain_content.delete | |
- mail_settings.spam_check.create | |
- mail_settings.spam_check.delete | |
- mail_settings.bounce_purge.create | |
- mail_settings.bounce_purge.delete | |
- mail_settings.forward_bounce.create | |
- mail_settings.forward_bounce.delete | |
- mail_settings.template.create | |
- mail_settings.template.delete | |
- mail.batch.create # create batch id for schedule and cancel scheduled sends | |
- mail.batch.delete # delete batch id for schedule and cancel scheduled sends | |
- mail.batch.read | |
- mail.batch.update | |
- mail.send # send mail | |
# Marketing Campaigns | |
- marketing_campaigns.create # perform POST operations on marketing campaign APIs | |
- marketing_campaigns.delete # perform DELETE operations on marketing campaign APIs | |
- marketing_campaigns.read # perform GET operations on marketing campaign APIs | |
- marketing_campaigns.update # perform PUT/PATCH operations on marketing campaign APIs | |
# Partner Settings | |
- partner_settings.new_relic.read # retrieve settings for the New Relic integration | |
- partner_settings.new_relic.update # modify settings for the New Relic integration | |
- partner_settings.read # retrieve a list of the available partner settings | |
- partner_settings.sendwithus.read # retrieve settings for the SendWithUs integration | |
- partner_settings.sendwithus.update # modify settings for the SendWithUs integration | |
- partner_settings.new_relic.create | |
- partner_settings.new_relic.delete | |
- partner_settings.sendwithus.create | |
- partner_settings.sendwithus.delete | |
# Scheduled Send | |
- user.scheduled_sends.create # create new scheduled send | |
- user.scheduled_sends.delete # delete existing scheduled send | |
- user.scheduled_sends.read # retrieve scheduled send | |
- user.scheduled_sends.update # update existing scheduled send | |
# Subusers | |
- subusers.create # create new subusers | |
- subusers.delete # delete existing subusers | |
- subusers.read # retrieve subusers | |
- subusers.update # update existing subusers | |
- subusers.credits.read # retrieve a subuser’s credit allocations | |
- subusers.credits.update # update a subuser’s credit allocations | |
- subusers.credits.remaining.update # update a subuser’s remaining credits | |
- subusers.monitor.create # create a monitor on the subuser | |
- subusers.monitor.delete # delete an existing monitor from the subuser | |
- subusers.monitor.read # retrieve a monitor on a subuser | |
- subusers.monitor.update # update an existing monitor on the subuser | |
- subusers.reputations.read # retrieve subuser reputations | |
- subusers.stats.read # retrieve subuser stats | |
- subusers.stats.monthly.read # retrieve subuser monthly stats | |
- subusers.stats.sums.read # retrieve summed subser stats | |
- subusers.summary.read # retrieve a summary of subsers | |
- subusers.credits.create | |
- subusers.credits.delete | |
- subusers.credits.remaining.create | |
- subusers.credits.remaining.read | |
- subusers.credits.remaining.delete | |
# Suppressions | |
- suppression.create # create a new suppression | |
- suppression.delete # delete an existing suppression | |
- suppression.read # retrieve suppressions | |
- suppression.update # update an existing suppression | |
- suppression.bounces.create | |
- suppression.bounces.read | |
- suppression.bounces.update | |
- suppression.bounces.delete | |
- suppression.blocks.create | |
- suppression.blocks.read | |
- suppression.blocks.update | |
- suppression.blocks.delete | |
- suppression.invalid_emails.create | |
- suppression.invalid_emails.read | |
- suppression.invalid_emails.update | |
- suppression.invalid_emails.delete | |
- suppression.spam_reports.create | |
- suppression.spam_reports.read | |
- suppression.spam_reports.update | |
- suppression.spam_reports.delete | |
- suppression.unsubscribes.create | |
- suppression.unsubscribes.read | |
- suppression.unsubscribes.update | |
- suppression.unsubscribes.delete | |
# Templates | |
- templates.create # create a template | |
- templates.delete # delete a template | |
- templates.read # retreive a template | |
- templates.update # update a template | |
- templates.versions.activate.create # sets the “active” field to 1 for specified version template | |
- templates.versions.activate.delete # sets the “active” field to 0 for specified version template | |
- templates.versions.activate.read # retrieve the active version for specified template | |
- templates.versions.activate.update # | |
- templates.versions.create # create a template version | |
- templates.versions.delete # delete a template version | |
- templates.versions.read # retrieve a specific version of a template | |
- templates.versions.update # update a template version | |
# Tracking | |
- tracking_settings.click.read # retrieve settings for click tracking | |
- tracking_settings.click.update # modify settings for click tracking | |
- tracking_settings.google_analytics.read # retrieve settings for google analytics | |
- tracking_settings.google_analytics.update # modify settings for google analytics | |
- tracking_settings.open.read # retrive settings for open tracking | |
- tracking_settings.open.update # modify settings for open tracking | |
- tracking_settings.read # retrive a list of the available tracking settings | |
- tracking_settings.subscription.read # retrieve settings for subscription tracking | |
- tracking_settings.subscription.update # modify settings for subscription tracking | |
- tracking_settings.click.create | |
- tracking_settings.click.delete | |
- tracking_settings.subscription.create | |
- tracking_settings.subscription.delete | |
- tracking_settings.open.create | |
- tracking_settings.open.delete | |
- tracking_settings.google_analytics.create | |
- tracking_settings.google_analytics.delete | |
# User Settings | |
- user.account.read # retrieve user account information | |
- user.credits.read # retrieve user credit information | |
- user.email.create # create new email | |
- user.email.delete # delete existing email | |
- user.email.read # retrieve email | |
- user.email.update # update existing email | |
- user.multifactor_authentication.create # add multifactor authentication to your account | |
- user.multifactor_authentication.delete # delete multifactor authentication from your account | |
- user.multifactor_authentication.read # retrieve multifactor authentication | |
- user.multifactor_authentication.update # update existing multifactor authentication | |
- user.password.create # create new password | |
- user.password.delete # delete existing password | |
- user.password.read # retrieve password | |
- user.password.update # update existing password | |
- user.profile.create # create new profile | |
- user.profile.delete # delete existing profile | |
- user.profile.read # retrieve profile | |
- user.profile.update # update existing profile | |
- user.settings.enforced_tls.read # retrieve enforced TLS settings | |
- user.settings.enforced_tls.update # update enforced TLS settings | |
- user.timezone.create # create new timezone | |
- user.timezone.delete # delete existing timezone | |
- user.timezone.read # retrieve timezone | |
- user.timezone.update # update existing timezone | |
- user.username.create # create new username | |
- user.username.delete # delete existing username | |
- user.username.read # retrieve username | |
- user.username.update # update existing username | |
# Webhook | |
- user.webhooks.event.settings.read # retrieve event webhook settings | |
- user.webhooks.event.settings.update # modify event webhook settings | |
- user.webhooks.parse.settings.create # create a hostname and url for parsing incoming mail | |
- user.webhooks.parse.settings.delete # delete existing settings for parsing incoming mail | |
- user.webhooks.parse.settings.read # retrieve settings for parsing incoming mail | |
- user.webhooks.parse.settings.update # update settings for parse incoming mail | |
- user.webhooks.parse.stats.read # retrieve parse webhook stats | |
- user.webhooks.event.settings.create | |
- user.webhooks.event.settings.delete | |
- user.webhooks.event.test.create | |
- user.webhooks.event.test.read | |
- user.webhooks.event.test.update | |
- user.webhooks.event.test.delete | |
# Whitelabel | |
- whitelabel.create # create whitelabels | |
- whitelabel.delete # delete existing whitelabels | |
- whitelabel.read # retrieve whitelabels | |
- whitelabel.update # update existing whitelabels | |
# Whitelist | |
- access_settings.whitelist.create # create new whitelist entries for account access | |
- access_settings.whitelist.delete # delete existing whitelist entries for account access | |
- access_settings.whitelist.read # retrieve whitelist entries for account access | |
- access_settings.whitelist.update # update existing whitelist entries for account access | |
- access_settings.activity.read | |
# Newsletter | |
- newsletter.create | |
- newsletter.read | |
- newsletter.update | |
- newsletter.delete | |
# Signup | |
- signup.trigger_confirmation | |
# UI | |
- ui.confirm_email | |
- ui.provision | |
- ui.signup_complete |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment