SendPulse app directory API scopes
Scopes give your app access to view, edit, and record data in user accounts and SendPulse tools using SendPulse Service REST API.
When adding your app to the directory, in the Scopes field, you can select tools whose data you will use.
Let’s talk about SendPulse API scopes and their data usage possibilities.
Scope | SendPulse tool | Your app permissions |
emails | Your app will have access to mailing lists, campaigns, senders, and other data from the Email section. |
You can create, edit, delete, and apply other actions to mailing lists, senders, and templates and retrieve data from them. You also will be able to add, get, edit, and delete contact data. For example, you can transfer contact data between your app and SendPulse. Learn more: Bulk Email Service API. |
smtp | Your app will have access to senders, statistics, and other data from the SMTP section. |
You can send emails and transfer certain user data and campaign statistics. You can also add senders and domains, remove email addresses from the list, and collect delivery error data. For example, you can send transactional emails. Learn more: SMTP Service API. |
automation |
Your app will have access to events, statistics, and other data from the Automation section. |
You can view statistics on every element, get a list of flows and completed series, and view your conversion data. For example, you can request flow statistics and add them to your reports. Learn more: API for Automation360. |
verifier_service | Your app will have access to data from the email verifier. |
You can verify contact lists and view your verification status and results. You can also create, view, and download mailing list verification reports. For example, you can verify recipient email addresses and use them in the future. Learn more: API for Verifying Email Addresses. |
chatbots | Your app will have access to your chatbot data and other information from the Chatbots section. |
You can get detailed chatbot data in your account or app installers’ accounts, including data on subscribers, variables, flows, and live chats. Depending on where your chatbot is hosted, you will be able to use more options. For example, you can transfer chatbot subscriber data using your app. Learn more: Chatbots service API. |
sms | Your app will have access to data from the SMS section. |
You can add phone numbers to mailing lists with or without variables, edit contacts’ phone numbers or variable lists, and get data on phone numbers or mailing lists. You can receive and update data on blacklists, create mailing lists, calculate SMS campaign prices, and delete mailing lists and phone numbers. For example, your app can trigger transactional SMS messages. Learn more: Bulk SMS Service API. |
viber | Your app will have access to data from the Viber section. |
You can create Viber campaigns and get campaign statistics, a list of campaigns, and a list of recipients. This scope allows you to add and remove phone numbers from the blacklist and get a list of blacklisted contacts. You can also view sender names individually or as a list. For example, you can add specific phone numbers from your database to the blacklist using your app. Learn more: Viber API. |
crm | Your app will have access to deals, contacts, and other data from the CRM section. |
You can get detailed data on pipelines, deals, contacts, attributes, and assigned users. You can also create deals and contacts and assign and delete fields, tags, and contact data. For example, your app may collect, send, or retrieve deal data or create contacts, deals, and tasks. Learn more: SendPulse CRM Public API. |
push_service | Your app will have access to campaign and website data from the Push section. |
You can create new web push campaigns and view their statistics, the total number of websites, sent web push campaigns, website data, the number of subscribers, JS code, and lists of websites, variables, and website subscribers. You can also activate or deactivate your subscribers. For example, you can transfer subscriber lists using your app and send web push notifications. Learn more: Web Push Notifications API. |
pop_ups | Your app will have access to projects and widgets from the Pop-ups section. |
You will be able to receive statistics on every project and pop-up and view their settings. For example, your app can add pop-up statistics to your CRM reports. Learn more: SendPulse Pop-up API. |
user_data | Your app will have access to your user data. |
You will be able to receive user data that isn't linked to any specific SendPulse tool, such as pricing plan data. |
You should only specify the scopes required for your app to operate properly.
Your selected scopes will affect your app moderation process.
Last Updated: 30.07.2024
or