ForumCategoriesApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createForumCategory | POST /community/categories | Create a new forum category |
| deleteForumCategory | DELETE /community/categories/{category_id} | Delete a forum category |
| getForumCategoryById | GET /community/categories/{category_id} | Get a forum category by ID |
| getForumCategoryBySlug | GET /community/categories/slug/{slug} | Get a forum category by slug |
| listForumCategories | GET /community/categories | List all forum categories |
| updateForumCategory | PUT /community/categories/{category_id} | Update a forum category |
createForumCategory
CreateForumCategoryResponse createForumCategory(CreateForumCategoryRequest)
Create a new forum category
Creates a new top-level category for organizing community discussions and topics. Categories serve as primary containers that group related forum threads together, making it easier for community members to navigate and find relevant discussions. Requires authentication to prevent unauthorized category creation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateForumCategoryRequest | CreateForumCategoryRequest | Category creation details including name, slug, and optional description |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteForumCategory
DeleteForumCategoryResponse deleteForumCategory(category_id)
Delete a forum category
Permanently removes a forum category from the community. This operation will fail if the category contains any posts or related content, ensuring data integrity and preventing accidental loss of community discussions. Requires authentication to prevent unauthorized deletion of forum structure.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Unique identifier of the category to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getForumCategoryById
GetForumCategoryResponse getForumCategoryById(category_id)
Get a forum category by ID
Retrieves detailed information about a specific forum category using its unique identifier. This endpoint is useful for accessing category details, descriptions, and metadata when the numeric ID is already known, such as from a previous API call or database reference.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Unique identifier of the forum category to retrieve | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getForumCategoryBySlug
GetForumCategoryResponse getForumCategoryBySlug(slug)
Get a forum category by slug
Retrieves detailed information about a specific forum category using its URL-friendly slug. This endpoint is ideal for building SEO-friendly URLs and human-readable routes in the community forum, allowing categories to be accessed via memorable identifiers like “general-discussion” or “support”.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| slug | String | URL-friendly slug identifier of the category (e.g., “general-discussion”) | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumCategories
ListForumCategoriesResponse listForumCategories(page, per_page)
List all forum categories
Retrieves a paginated list of all forum categories available in the community. This endpoint provides an overview of the forum structure, allowing users to browse and discover different discussion areas. Results are paginated for optimal performance and can be customized with page size preferences.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (defaults to 1) | [optional] [default to null] |
| per_page | Integer | Number of categories per page (defaults to 20) | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateForumCategory
UpdateForumCategoryResponse updateForumCategory(category_id, UpdateForumCategoryRequest)
Update a forum category
Updates an existing forum category’s details including name, slug, or description. This endpoint allows moderators and administrators to refine category organization, fix typos, or adjust category structure as the community evolves. Requires authentication to ensure only authorized users can modify the forum structure.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Unique identifier of the category to update | [default to null] |
| UpdateForumCategoryRequest | UpdateForumCategoryRequest | Updated category details including optional name, slug, and description changes |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8