HelpApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| cmsGetHelpArticleById | GET /cms/help/articles/{id} | Get help article by ID |
| cmsGetHelpArticleBySlug | GET /cms/help/articles/slug/{slug} | Get help article by slug |
| cmsGetHelpCategoryBySlug | GET /cms/help/categories/{slug} | Get help category by slug |
| cmsListHelpArticles | GET /cms/help/articles | List published help articles |
| cmsListHelpCategories | GET /cms/help/categories | List help categories |
| createSupportTicket | POST /support/tickets | Create a new support ticket |
| createSupportTicketReply | POST /support/tickets/{ticket_id}/replies | Add a reply to a support ticket |
| getSupportTicket | GET /support/tickets/{ticket_id} | Get a specific support ticket |
| listSupportTemplates | GET /support/templates | Get available support templates for users |
| listSupportTicketReplies | GET /support/tickets/{ticket_id}/replies | Get replies for a support ticket |
| listSupportTickets | GET /support/tickets | List user’s support tickets |
| reopenSupportTicket | POST /support/tickets/{ticket_id}/reopen | Reopen a resolved ticket |
| resolveSupportTicket | POST /support/tickets/{ticket_id}/resolve | Mark a ticket as resolved |
| updateSupportTicket | PUT /support/tickets/{ticket_id} | Update a support ticket |
cmsGetHelpArticleById
HelpArticleResponse cmsGetHelpArticleById(id)
Get help article by ID
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
cmsGetHelpArticleBySlug
HelpArticleResponse cmsGetHelpArticleBySlug(slug)
Get help article by slug
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| slug | String | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
cmsGetHelpCategoryBySlug
HelpCategoryResponse cmsGetHelpCategoryBySlug(slug)
Get help category by slug
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| slug | String | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
cmsListHelpArticles
PaginatedResponse_HelpArticleResponse cmsListHelpArticles(page, per_page, category_id)
List published help articles
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] | |
| category_id | Long | [optional] [default to null] |
Return type
PaginatedResponse_HelpArticleResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
cmsListHelpCategories
PaginatedResponse_HelpCategoryResponse cmsListHelpCategories(page, per_page, language)
List help categories
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] | |
| language | String | [optional] [default to null] |
Return type
PaginatedResponse_HelpCategoryResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
createSupportTicket
TicketResponse createSupportTicket(CreateTicketPayload)
Create a new support ticket
Submits a new customer support ticket with a subject, description, and optional metadata like priority, type, and related order information. The ticket is automatically associated with the authenticated user’s account.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateTicketPayload | CreateTicketPayload | Ticket creation details including subject, description, and optional metadata |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createSupportTicketReply
ReplyResponse createSupportTicketReply(ticket_id, CreateReplyPayload)
Add a reply to a support ticket
Submits a new reply message to an existing support ticket. Users can add text or HTML content and attach files to provide additional context or information. Replies are visible to both the customer and support agents handling the ticket.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the ticket to reply to | [default to null] |
| CreateReplyPayload | CreateReplyPayload | Reply content including message text and optional attachments |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getSupportTicket
TicketResponse getSupportTicket(ticket_id)
Get a specific support ticket
Retrieves detailed information about a single support ticket by its ID. Users can only access their own tickets. Returns the full ticket details including metadata, status, priority, and associated information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the ticket to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listSupportTemplates
PaginatedResponse_TemplateResponse listSupportTemplates(page, per_page)
Get available support templates for users
Retrieves pre-defined response templates that customers can use to quickly create support tickets for common issues. Templates include suggested subjects, descriptions, and categorization to streamline the ticket creation process.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page for pagination (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_TemplateResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listSupportTicketReplies
ReplyListResponse listSupportTicketReplies(ticket_id, page, per_page)
Get replies for a support ticket
Retrieves all replies and conversation history for a specific support ticket. Returns messages from both the customer and support agents in chronological order, excluding internal notes that are only visible to support staff.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the ticket whose replies to retrieve | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page for pagination (default: 20) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listSupportTickets
PaginatedResponse_TicketResponse listSupportTickets(status, priority, search, page, per_page)
List user’s support tickets
Retrieves a paginated list of all support tickets created by the authenticated user. Results can be filtered by status, priority, or search keywords, and supports pagination for efficient browsing of ticket history.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | TicketStatus | Filter tickets by status (e.g., open, in_progress, resolved) | [optional] [default to null] [enum: New, Assigned, InProgress, WaitingCustomer, WaitingVendor, WaitingInternal, Escalated, Resolved, Closed, Cancelled, Spam] |
| priority | TicketPriority | Filter tickets by priority level (e.g., low, medium, high, urgent) | [optional] [default to null] [enum: Low, Normal, High, Urgent, Critical] |
| search | String | Search tickets by keywords in subject or description | [optional] [default to null] |
| page | Integer | Page number for pagination (defaults to 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (defaults to 20) | [optional] [default to null] |
Return type
PaginatedResponse_TicketResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
reopenSupportTicket
TicketResponse reopenSupportTicket(ticket_id)
Reopen a resolved ticket
Reopens a previously resolved or closed support ticket to continue the conversation. This is useful when the original issue persists, returns, or if new related problems arise that require further assistance from the support team.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the resolved ticket to reopen | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
resolveSupportTicket
TicketResponse resolveSupportTicket(ticket_id)
Mark a ticket as resolved
Closes a support ticket by marking it as resolved, indicating that the issue has been addressed satisfactorily. Resolved tickets can be reopened if the issue persists or if additional assistance is needed by calling the reopen endpoint.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the ticket to mark as resolved | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateSupportTicket
TicketResponse updateSupportTicket(ticket_id, UpdateTicketPayload)
Update a support ticket
Modifies an existing support ticket’s details such as subject, description, priority, or status. Users can only update their own tickets and have limited access to certain fields that are typically managed by support agents.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket_id | Long | Unique identifier of the ticket to update | [default to null] |
| UpdateTicketPayload | UpdateTicketPayload | Updated ticket details (all fields are optional) |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8