API Permissions Overview
This document provides a detailed overview of API permissions across different user roles in the system.
Each section is grouped by operation type (Accounts, Users, Media, Bots, and Analytics) and shows which roles have access to specific actions.
- Columns represent user roles (e.g., Viewer, Editor, Admin, etc.).
- Rows represent the available operations.
- A check mark (✓) indicates that the given role has permission to perform the corresponding operation.
Account Operations
| Permission | Viewer | Editor | Admin | Owner |
|---|---|---|---|---|
| Read one account | ✓ | ✓ | ✓ | ✓ |
| Read one account full detail | ✓ | |||
| Read account profile | ✓ | ✓ | ✓ | ✓ |
| Update account profile | ✓ | ✓ | ||
| Update account | ✓ | |||
| Third Party Integrations | ✓ |
User Operations
| Permission | Viewer | Editor | Admin | Owner |
|---|---|---|---|---|
| Read users list for an account | ✓ | ✓ | ||
| Read a user (by ID) | ✓ | ✓ | ||
| Invite a user to an account | ✓ | ✓ | ||
| Remove a user from an account | ✓ | ✓ | ||
| Update a user’s role in an account | ✓ | ✓ | ||
| Update another user (shared account + safe fields) | ✓ | ✓ | ✓ | ✓ |
Media Operations
| Permission | Viewer | Editor | Admin | Owner |
|---|---|---|---|---|
| Create a new media | ✓ | ✓ | ✓ | |
| Update media | ✓ | ✓ | ✓ | ✓ |
| Get all media records for an account | ✓ | ✓ | ✓ | ✓ |
| Delete a media | ✓ | ✓ | ✓ | |
| Upload caption | ✓ | ✓ | ✓ | ✓ |
| Delete caption | ✓ | ✓ | ✓ | ✓ |
Bot Operations
| Permission | Viewer | Editor | Admin | Owner |
|---|---|---|---|---|
| Read videobots | ✓ | ✓ | ✓ | ✓ |
| Read bot widget | ✓ | ✓ | ✓ | ✓ |
| Read bot embed (public id) | ✓ | ✓ | ✓ | ✓ |
| Read bot widget embed (public id) | ✓ | ✓ | ✓ | ✓ |
| Create a new videobot | ✓ | ✓ | ✓ | |
| Update videobot | ✓ | ✓ | ✓ | |
| Update bot widget | ✓ | ✓ | ✓ | |
| Delete a videobot | ✓ | ✓ | ✓ | |
| Clone bot (same account) | ✓ | ✓ | ✓ | ✓ |
| Copy bot to another account | ✓ | ✓ | ✓ | |
| Read bot revisions | ✓ | ✓ | ✓ | ✓ |
| Read a specific bot revision | ✓ | ✓ | ✓ | ✓ |
| Publish a bot revision | ✓ | ✓ | ✓ | |
| Submit a lead (form submit) | ✓ | ✓ | ✓ | ✓ |
Analytics
| Permission | Viewer | Editor | Admin | Owner |
|---|---|---|---|---|
| Read paginated bot analytics | ✓ | ✓ | ✓ | ✓ |
| Read account total analytics | ✓ | ✓ | ✓ | ✓ |
| Read widget analytics (paginated) | ✓ | ✓ | ✓ | ✓ |
| Read detailed bot analytics | ✓ | ✓ | ✓ | ✓ |
| Read analytics report | ✓ | ✓ | ✓ | ✓ |
| Read account daily total analytics | ✓ | ✓ | ✓ | ✓ |
| Submit analytics event (ingest) | ✓ | ✓ | ✓ | ✓ |