OAuth Scopes
OAuth scopes, or permissions, let you specify exactly how your application needs to access a Podium user’s account.
You should only specify the scopes you need to satisfy your use case and no more. Scopes are the most common reason that apps aren't approved when it comes to reviews.
User permissions
The user that authorizes your app must have permission to access the corresponding feature. For example, if the user does not have permission to view the invoices page in Podium, then your request to the invoice resource will return a 403 - Forbidden status.
Summary of all OAuth scopes
The following scopes are available for an application to obtain authorization from a user.
| Scopes | Displayed Scope to User | Description |
|---|---|---|
| write_appointments | Write Appointments | Grant access to create appointments in the user's locations. |
| read_campaigns | Read campaigns | Grant access to read campaign data for the user's locations. |
| write_campaign_messages | Write campaign messages | Grant access to write campaign messages for the user's locations. |
| write_contacts | Write Contacts | Grant access to create, update, and delete contact data for the user's locations. |
| write_data_feed_event | Trigger a data feed event | Grant access to trigger data feed events for the user's locations. |
| read_feedback | Read feedback data | Grant access to all feedback data for the user's locations. |
| read_locations | Read location data | Grant access to the user's locations. |
| read_messages | Read message data | Grant access to all messages for the user's locations. |
| write_messages | Write messages | Grant access to write messages in the user's locations. |
| read_organizations | Read organization data | Grant access to the user's organization. |
| read_payments | Read payments data | Grant access to all payment data for to the user's locations. |
| write_payments | Write payments data | Grant access to create payments for all the user's locations. |
| read_reviews | Read reviews data | Grant access to all review data for the user's locations. |
| write_reviews | Write reviews data | Grant access to create reviews data for all the user's locations. |
| read_users | Read user data | Grant access to all user data for the user's locations. |
| read_contacts | Read contact data | Grant access to all contact data for the user's locations. |
| write_locations | Write location data | Grant access to write locations. |
Updated about 2 years ago