Skip to Content

FavouriteServicesApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
addFavouriteServicePOST /favourites/servicesAdd service to favourites
listFavouriteServicesGET /favourites/servicesList favourite services
removeFavouriteServiceDELETE /favourites/services/{id}Remove service from favourites

addFavouriteService

MessageResponse addFavouriteService(AddFavouriteServiceInput)

Add service to favourites

Marks a service as a favourite for the authenticated user.

Parameters

NameTypeDescriptionNotes
AddFavouriteServiceInputAddFavouriteServiceInput

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

listFavouriteServices

PaginatedResponse_FavouriteServiceResponse listFavouriteServices(page, per_page)

List favourite services

Retrieves all services the user has marked as favourites.

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_FavouriteServiceResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

removeFavouriteService

MessageResponse removeFavouriteService(id)

Remove service from favourites

Removes a service from the user’s favourites list.

Parameters

NameTypeDescriptionNotes
idLong[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8