API specification

How to read the documentation

We are hard at work to make this documentation as readable and user-friendly as possible. Here is a quick guide as to how to read this documentation:

• The type is specified underneath the parameter name.

• Sometimes this is a .

• If there is an equals sign next to the parameter type, it indicates that this parameter is optional. The value after the equals sign indicates the default value that will be used if no value is specified.

Chat endpoints

All the endpoints that can be called on the Chat controller.

All endpoints require the API_CHAT permission.

Customer endpoints

All the endpoints that can be called on the Customer controller.

Endpoints that require the CUSTOMER_READ permission:

• GET index

• GET item

• POST searchByPrimaryExternalId

• GET timelineByCustomerExternalID

Endpoints that require the CUSTOMER_CUD permission:

• POST index

• PUT index

• PUT item

• DELETE item

• POST addChannelOnly

• PUT updateCustomer

• DELETE itemChannel

• DELETE itemPurgeData

• POST externalEvent

• POST syncWithCRM

• POST createCustomerCRUD

Email endpoints

All the endpoints that can be called on the Email controller.

All these endpoints require the SETTINGS_CRUD permission, except for GET itemDownloadMail, which requires TICKET_READ

Form endpoints

All the endpoints that can be called on the Form controller.

Endpoints that require the FORM_READ permission:

• GET index

• GET item

• GET getFormForTicket

Endpoints that require the FORM_CUD permission:

• POST index

• PUT item

• DELETE item

Additionally, PUT saveFormFields requires the FORM_SAVE permission.

Formfield endpoints

All the endpoints that can be called on the Formfield controller.

Each endpoint requires the FORM_CUD permission, except for GET index, which requires the FORM_READ permission.

Message endpoints

All the endpoints that can be called on the Message controller.

All of the endpoints require the MESSAGE_CREATE permission.

Notification endpoints

All the endpoints that can be called on the Notification controller.

All the endpoints require the SETTINGS_CRUD permission.

Raw endpoints

All the endpoints that can be called on the Raw controller.

All the endpoints require the API_RAW_TABLE_READ permission.

Statisticsv2 endpoints

All the endpoints that can be called on the Statisticsv2 controller.

All the endpoints require the API_STATISTICS permission, except for:

• POST dashboardDelete

• PUT dashboard

Which require the DASHBOARD_CUD permission.

Ticket endpoints

All the endpoints that can be called on the Ticket controller.

Endpoints that require the TICKET_READ permission:

• GET index

• GET item

Endpoints that require the TICKET_CREATE permission:

• POST index

Endpoints that require the TICKET_UPDATE permission:

• PUT item

• POST setPriority

Endpoints that require the TICKET_DELETE permission:

• DELETE item

• DELETE multi

Endpoints that require the SET_STATUS permission:

• POST setStatus

• PUT solveUnfinishedTickets

Endpoints that require the TICKET_BATCH permission:

• POST batch

User endpoints

All the endpoints that can be called on the User controller.

Endpoints that require the USER_READ permission:

• GET index

• GET settings

Endpoints that require the API_RESERVER_USER permission:

• POST reserveUserForLiveChannel

Endpoints that require the USER_ANONYMOUS_BROWSING_UPDATE permission:

• PUT ticketIncognitoMode

All other endpoints require the USER_CUD permission.

View endpoints

All the endpoints that can be called on the View controller.

Endpoints that require the VIEW_READ permission:

• GET index

Endpoints that require the VIEW_CUD permission:

• POST index

• POST item

• DELETE item

Endpoints that require the GROUP_CUD permission:

• GET item

Endpoints that require the SETTINGS_CRUD permission:

• GET viewCategories