Wix Answers Help Center
Developers: API Roles and Permissions
For an introduction to API keys, roles, and permissions, see App Settings, Roles, and Permissions.
Some endpoints can be accessed only by an agent with the relevant permission. When an agent sends a token generated from an API key (possibly on behalf of a specific user), the API key and the agent on behalf of whom the token was created must have the relevant permission.
In addition to endpoints that require a specific permission:
- Some endpoints do not require any permission, and do not require an API key.
- Some endpoints can be accessed by any registered user using an API key, who does not have to be an agent.
- Some endpoints can be accessed only by an agent using an API key (with any role), but do not require a specific permission.
These cases are noted where relevant in the documentation.
The following sections present the permissions and their enumeration numbers, together with the API endpoints for which each permission is required.
Role: Except where noted, agents with the Admin role have all permissions, including those marked Admin, Agent, or Viewer. Agents with the Agent role have all permissions marked Agent or Viewer. Agents with the Viewer role have permissions marked Viewer.
API Key Setting: Except where noted, API keys with Edit also have all permissions marked as View
for the same feature.
To see which permissions are required for each API endpoint, see the relevant API documentation pages.
Article and Category Permissions
FETCH_ARTICLES (20)
View and search articles.
- Role: Viewer
- API Key Settings: Knowledge Base View
- Endpoints:
- Get Extended Article Information
- Get List of Article Versions
- Get an Article's Related Articles (Agent)
- Search for Articles (Agent)
- Search for Articles by Ticket
- Get the Number of Articles in a Category
- Get Article Task Information
- Get All Article Tasks
- Get a Count of an Article's Tasks
- Get Article Note
- Get All Article Notes
- Get Article Comments
- Get Article Comment Replies
CREATE_ARTICLES (30)
Add and edit articles.
- Role: Agent
- API Key Settings: Knowledge Base Edit
- Endpoints:
- Add Article
- Get Article Preview
- Add Article Translations
- Restore Deleted Article
- Update Article Category
- Move Articles in Bulk
- Move All Articles from One Category to Another
- Update Article Type
- Update Article Resolution
- Update Article Title and/or Content
- Update Article Phrases
- Update Article Labels
- Manage Article Labels in Bulk
- Add Article Tasks in Bulk
- Add Article Translations in Bulk
- Delete Articles in Bulk
- Merge Articles
- Sort Articles in a Category
- Delete All Articles in a Category
- Add Article Relation
- Delete Article Relation
- Sort an Article's Related Articles
- Add Article Task
- Update Article Task
- Complete Article Task
- Open / Reopen Article Task
- Delete an Article Task
- Delete One or More Article Tasks
- Add Article Note
- Update Article Note
- Delete Article Note
- Add Article Task Note
- Update Article Task Note
- Delete Article Task Note
- Add Article Comment
- Update Article Comment
- Delete Article Comment
- Mark Article Comment as Resolved or not Resolved
- Add Article Comment Reply
- Update Article Comment Reply
- Delete Article Comment Reply
- Duplicate Articles
PUBLISH_ARTICLES (40)
Publish and unpublish articles.
- Role: Agent
- API Key Settings: Knowledge Base Edit
- Endpoints:
DELETE_ARTICLES (50)
Delete articles.
- Role: Agent
- API Key Settings: Knowledge Base Edit
- Endpoints:
FETCH_CATEGORIES (70)
View category information and search categories.
- Role: Viewer
- API Key Settings: Knowledge Base View
- Endpoints:
MANAGE_CATEGORIES (80)
Add, edit, and delete categories.
- Role: Admin
- API Key Settings: Knowledge Base Edit
- Endpoints:
Ticket Permissions
FETCH_TICKETS (100)
View or search for tickets, or follow or unfollow a ticket.
- Role: Viewer
- API Key Settings: Ticket View
- Endpoints:
- Get a Ticket by ID
- Get a Ticket by Ticket Reference Number
- Get Ticket Replies for a Ticket
- Get All Ticket Replies Between Specific Times
- Get a Ticket's Timeline (Agent)
- Get a Ticket's Related Articles (Agent)
- Search Tickets (Agent)
- Get List of Users Who Follow a Ticket
- Get Whether You Follow a Ticket (Agent)
- Get List of Tickets You Follow (Agent)
- Follow a Ticket
- Unfollow a Ticket
FETCH_TICKET_VIEWS (109)
View saved filters.
- Role: Viewer
- API Key Settings: Ticket View
- Endpoints:
- Get the Number of Tickets Matching One or More Saved Filters
- Get a Saved Filter [in some cases]
- Get Saved Filters [in some cases]
- Get Saved Filters for One or More Locales [in some cases]
MANAGE_SHARED_TICKET_VIEWS (110)
Manage public saved filters.
- Role: Admin
- API Key Settings: Ticket Edit
- Endpoints:
- Add a Saved Filter [in some cases]
- Update Saved Filter Criteria [in some cases]
- Rename a Saved Filter [in some cases]
- Delete a Saved Filter [in some cases]
MANAGE_PRIVATE_TICKET_VIEWS (111)
Manage private saved filters.
- Role: Admin
- API Key Settings: Ticket Edit
- Endpoints:
- Add a Saved Filter [in some cases]
- Update Saved Filter Criteria [in some cases]
- Rename a Saved Filter [in some cases]
- Delete a Saved Filter [in some cases]
- Get a Saved Filter [in some cases]
- Get Saved Filters [in some cases]
- Get Saved Filters (New) [in some cases]
- Get Saved Filters for One or More Locales [in some cases]
CREATE_TICKETS (120)
Create tickets.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
CREATE_CHAT_TICKETS (141)
Create tickets from chat messages.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
CREATE_SMS_TICKETS (142)
Create tickets from SMS messages. Used in the Wix Answers app, only.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints: None
CREATE_AGENT_REPLIES (150)
Create agent replies and/or internal notes.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
- Add Agent Reply or Internal Note to a Ticket
- Add Internal Note to a Ticket, if newTicketStatus is set
- Add Agent Replies or Internal Notes to One or More Tickets
- Add Internal Notes to One or More Tickets, if newTicketStatus is set
CREATE_AGENT_INTERNAL_NOTE (151)
Create agent internal notes, without ability to change ticket status or handling.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints: None
MANAGE_TICKETS (160)
Delete or update tickets.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
BASIC_TICKET_ACTIONS (161)
Update basic information about a ticket.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
- Update a Ticket's Custom Fields
- Update a Ticket's Status
- Update Status of One or More Tickets
- Update a Ticket's Locale
- Update Locale of One or More Tickets
- Update a Ticket's Priority
- Update Priority of One or More Tickets
- Update a Ticket's Labels
- Update Labels of One or More Tickets
- Assign a Ticket
- Assign One or More Tickets
- Unassign a Ticket
- Unassign One or More Tickets
- Add Related Articles to a Ticket
- Add Related Articles to One or More Tickets
- Remove Related Articles from a Ticket
- Remove Related Articles from One or More Tickets
- Mark a Ticket as Not Spam
- Mark One or More Tickets as Not Spam
- Mark A Ticket as Spam
- Mark One or More Tickets as Spam
- Add a User Note
- Start Handling a Ticket (Agent)
- End Handling a Ticket (Agent)
- End Handling of One or More Tickets (Agent)
SNOOZE_TICKETS (162)
Snooze and unsnooze tickets.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
MANAGE_TICKET_REPLIES (163)
Manage ticket replies.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints: None
MERGE_TICKETS (164)
Merge tickets.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints: None
DELETE_TICKETS (165)
Delete tickets.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints: None
FETCH_SAVED_REPLIES (170)
View and search for saved replies.
- Role: Viewer
- API Key Settings: Saved Replies View
- Endpoints:
MANAGE_SAVED_REPLIES (180)
Manage saved replies.
- Role: Admin
- API Key Settings: Saved Replies Edit
- Endpoints:
- Add a Saved Reply [in some cases]
- Update a Saved Reply [in some cases]
- Delete a Saved Reply [in some cases]
Chat Permissions
FETCH_CHAT_TICKETS (200)
View chat tickets.
- Role: Viewer
- API Key Settings: Ticket View
- Endpoints:
- Search Chat Messages by Date
PARTICIPATE_IN_CHATS (210)
Send a chat message as an agent.
- Role: Agent
- API Key Settings: None
- Endpoints:
FETCH_CHAT_VIEWS (229)
View or search for saved chat filters.
- Role: Viewer
- API Key Settings: Ticket View
- Endpoints:
- Get a Saved Filter [in some cases]
- Get Saved Filters [in some cases]
- Get Saved Filters for One or More Locales [in some cases]
MANAGE_CHAT_VIEWS (230)
Manage saved chat filters.
- Role: Admin
- API Key Settings: Ticket Edit
- Endpoints:
- Add a Saved Filter [in some cases]
- Update Saved Filter Criteria [in some cases]
- Rename a Saved Filter [in some cases]
- Delete a Saved Filter [in some cases]
Call Center Permissions
FETCH_CALLS (250)
View call information.
- Role: Viewer
- API Key Settings: Call Recordings View
- Endpoints: None
AUDIT_CALL_RECORDINGS (290)
Manage call recordings.
- Role: Viewer
- API Key Settings: Call Recordings View
- Endpoints: None
DELETE_CALL_RECORDINGS (310)
Delete call recordings.
- Role: Admin
- API Key Settings: Call Recordings Edit
- Endpoints: None
FETCH_CALL_RECORDINGS (320)
View call recordings.
- Role: Viewer
- API Key Settings: Call Recordings View
- Endpoints: None
User and Company Permissions
FETCH_CONTACTS (340)
View user information and search for users.
- Role: Viewer
- API Key Settings: Contacts View
- Endpoints:
MANAGE_CONTACTS (350)
Manage user information.
- Role: Agent
- API Key Settings: Contacts Edit
- Endpoints:
- Add User
- Add Users in Bulk
- Update a User
- Update (or Add) Unauthenticated User
- Update an SSO User
- Ban a User
- Remove a User Ban
- Add One or More Companies to a User
- Set User Permissions for Companies
- Update a User's Custom Fields
- Delete a Ticket [in some cases]
- Delete One or More Tickets [in some cases]
- Update Company of a Ticket and Ticket User (Owner)
FETCH_COMPANIES (370)
Get or search for companies.
- Role: Viewer
- API Key Settings: Contacts View
- Endpoints:
MANAGE_COMPANIES (380)
Manage companies.
- Role: Admin
- API Key Settings: Contacts Edit
- Endpoints:
Insight Permissions
FETCH_INSIGHTS (390)
View insights. Used in the Wix Answers app, only.
- Role: Viewer
- API Key Settings: Insights View
- Endpoints: None
FETCH_TEAM_PERFORMANCE (400)
View team performance. Used in the Wix Answers app, only.
- Role: Agents with Viewer or Admin roles have this permission. Agents with Agent role do not.
- API Key Settings: Insights View
- Endpoints: None
Settings Permissions
FETCH_CALLCENTER_SETTINGS (420)
Get call center information.
- Role: Viewer
- API Key Settings: Call Recordings View
- Endpoints:
FETCH_TICKETS_CUSTOM_FIELDS (490)
Get ticket custom fields.
- Role: Viewer
- API Key Settings: Ticket View
- Endpoints:
- Get Custom Field Information (Admin) [Tickets]
- Get All Custom Fields (Admin) [Tickets]
MANAGE_TICKETS_CUSTOM_FIELDS (500)
Manage ticket custom fields.
- Role: Admin
- API Key Settings: Ticket Edit
- Endpoints:
- Add Custom Field [Tickets]
- Update Custom Field Name or Data Type [Tickets]
- Delete Custom Field [Tickets]
FETCH_USERS_CUSTOM_FIELDS (510)
Get user custom fields.
- Role: Viewer
- API Key Settings: Contacts View
- Endpoints:
- Get Custom Field Information (Admin) [Users]
- Get All Custom Fields (Admin) [Users]
MANAGE_USERS_CUSTOM_FIELDS (520)
Manage user custom fields.
- Role: Admin
- API Key Settings: Contacts Edit
- Endpoints:
- Add Custom Field [Users]
- Update Custom Field Name or Data Type [Users]
- Delete Custom Field [Users]
FETCH_COMPANIES_CUSTOM_FIELDS (530)
Get company custom fields.
- Role: Viewer
- API Key Settings: Contacts View
- Endpoints:
- Get Custom Field Information (Admin) [Companies]
- Get All Custom Fields (Admin) [Companies]
MANAGE_COMPANIES_CUSTOM_FIELDS (540)
Manage company custom fields.
- Role: Admin
- API Key Settings: Contacts Edit
- Endpoints:
- Add Custom Field [Companies]
- Update Custom Field Name or Data Type [Companies]
- Delete Custom Field [Companies]
FETCH_AGENTS_CUSTOM_FIELDS (550)
Get agent custom fields.
- Role: Viewer
- API Key Settings: Team Members View
- Endpoints:
- Get Custom Field Information (Admin) [Agents]
- Get All Custom Fields (Admin) [Agents]
MANAGE_AGENTS_CUSTOM_FIELDS (560)
Manage agent custom fields.
- Role: Admin
- API Key Settings: Team Members Edit
- Endpoints:
- Add Custom Field [Agents]
- Update Custom Field Name or Data Type [Agents]
- Delete Custom Field [Agents]
FETCH_LABELS (620)
Get labels.
- Role: Viewer
- API Key Settings: Labels View
- Endpoints:
MANAGE_LABELS (630)
Manage labels.
- Role: Admin
- API Key Settings: Labels Edit
- Endpoints:
FETCH_TEAM_MEMBERS (640)
Get agent, team, or location information.
- Role: Viewer
- API Key Settings: Team Members View
- Endpoints:
MANAGE_TEAM_MEMBERS (650)
Manage agents, teams, and locations.
- Role: Admin
- API Key Settings: Team Members Edit
- Endpoints:
MANAGE_GROUP_ASSIGNMENTS (651)
Manage which agents are assigned to groups.
- Role: Admin
- API Key Settings: Team Members Edit
- Endpoints:
FETCH_MACROS (670)
Get macro information.
- Role: Viewer
- API Key Settings: None
- Endpoints:
FETCH_ACCOUNT_SETTINGS (690)
Fetch account information.
- Role: Viewer
- API Key Settings: None
- Endpoints:
MANAGE_ACCOUNT_SETTINGS (700)
Configure account information.
- Role: Admin
- API Key Settings: None
- Endpoints:
END_HANDLE_TICKET_SESSIONS (750)
Remove all agents from handling a ticket.
- Role: Admin
- API Key Settings: N/A
- Endpoints:
- End All Handling of a Ticket
- End All Ticket Handling By One or More Agents
- End All Handling of One or More Tickets
- Add Agent Reply or Internal Note to a Ticket if endAllHandling is true
- Add Internal Note to a Ticket if endAllHandling is true
FETCH_CSAT (761)
Get CSAT submissions.
- Role: Admin
- API Key Settings: Ticket View
- Endpoints:
FETCH_IN_APP_NOTIFICATION_SETTINGS (771)
Get settings of in-app notifications.
- Role: Viewer
- API Key Settings: N/A
- Endpoints: None
MANAGE_IN_APP_NOTIFICATION_SETTINGS (772)
Manage settings of in-app notifications.
- Role: Admin
- API Key Settings: N/A
- Endpoints: None
MANAGE_CHANNEL_ASSIGNMENT (811)
Manage agent features (for auto-routing tickets).
- Role: Admin
- API Key Settings: N/A
- Endpoints:
MANAGE_CHANNEL_WORKLOAD (812)
Manage agent feature workloads (for auto-routing tickets).
- Role: Admin
- API Key Settings: N/A
- Endpoints:
ADD_CUSTOM_TICKET_TIMELINE_EVENT (880)
Add an event to a ticket timeline.
- Role: Agent
- API Key Settings: Ticket Edit
- Endpoints:
FETCH_BRAND (920)
View brand information.
- Role: Viewer
- API Key Settings: Brands View
- Endpoints:
Was this article helpful?