Support-Category

Get Ticket Categories

get

This API retrieves a list of support ticket categories based on the query parameters.

Query parameters

limitnumberOptional

Limit the number of results.

Example: 10

offsetnumberOptional

The offset from where to start the results.

Example: 0

keywordstringOptional

Search keyword for filtering categories.

Example: shipping

parentCategoryIdstringOptional

Filter by parent category ID.

Example: 1

statusstringOptional

Filter by category status.

Example: 1

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the ticket categories

application/json

500

Failed to retrieve ticket categories

application/json

get

HTTPcURLJavaScriptPython

GET /backend/api/support-ticket/ticket-category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Ticket categories retrieved successfully",
  "data": [
    {
      "createdBy": "admin",
      "createdDate": "2025-04-01T10:00:00Z",
      "modifiedBy": "admin",
      "modifiedDate": "2025-04-01T10:30:00Z",
      "id": 123,
      "categoryName": "Shipping Issues",
      "parentCategoryId": 1,
      "isActive": true,
      "isDelete": false
    }
  ]
}

Create Ticket Category

post

This API creates a new support ticket category.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

categoryNamestringOptionalExample: Shipping Issues

parentCategoryIdintegerOptionalExample: 1

isActivebooleanOptionalExample: true

isDeletebooleanOptionalExample: false

Responses

201

Ticket category created successfully

application/json

400

Invalid request data

application/json

500

Failed to create ticket category

application/json

post

HTTPcURLJavaScriptPython

POST /backend/api/support-ticket/ticket-category HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "categoryName": "Shipping Issues",
  "parentCategoryId": 1,
  "isActive": true,
  "isDelete": false
}

{
  "status": "1",
  "message": "Ticket category created successfully",
  "data": {
    "id": 124,
    "categoryName": "Shipping Issues",
    "parentCategoryId": 1,
    "isActive": true,
    "isDelete": false
  }
}

Get Ticket Category by ID

get

This API retrieves a specific support ticket category based on the provided category ID.

Path parameters

idintegerRequired

The unique ID of the ticket category.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully retrieved the ticket category

application/json

500

Failed to retrieve ticket category

application/json

get

HTTPcURLJavaScriptPython

GET /backend/api/support-ticket/ticket-category/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Ticket category retrieved successfully",
  "data": {
    "createdBy": "admin",
    "createdDate": "2025-04-01T10:00:00Z",
    "modifiedBy": "admin",
    "modifiedDate": "2025-04-01T10:30:00Z",
    "id": 123,
    "categoryName": "Shipping Issues",
    "parentCategoryId": 1,
    "isActive": true,
    "isDelete": false
  }
}

Update Ticket Category

put

This API allows users to update a specific support ticket category based on the provided category ID.

Path parameters

idintegerRequired

The unique ID of the ticket category to be updated.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Body

categoryNamestringOptionalExample: Updated Category Name

statusnumberOptionalExample: 1

parentCategoryIdintegerOptionalExample: 1

Responses

200

Successfully updated the ticket category

application/json

500

Failed to update ticket category

application/json

put

HTTPcURLJavaScriptPython

PUT /backend/api/support-ticket/ticket-category/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "categoryName": "Updated Category Name",
  "status": 1,
  "parentCategoryId": 1
}

{
  "status": 1,
  "message": "Ticket category updated successfully",
  "data": {
    "createdBy": "admin",
    "createdDate": "2025-04-01T10:00:00Z",
    "modifiedBy": "admin",
    "modifiedDate": "2025-04-01T10:30:00Z",
    "id": 123,
    "categoryName": "Updated Category Name",
    "parentCategoryId": 1,
    "isActive": true,
    "isDelete": false,
    "categoryType": "general"
  }
}

Delete Ticket Category

delete

This API allows users to delete a specific support ticket category based on the provided category ID.

Path parameters

idintegerRequired

The unique ID of the ticket category to be deleted.

Header parameters

AuthorizationstringRequired

Bearer token for authentication.

Responses

200

Successfully deleted the ticket category

application/json

500

Failed to delete ticket category

application/json

delete

HTTPcURLJavaScriptPython

DELETE /backend/api/support-ticket/ticket-category/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: text
Accept: */*

{
  "status": "1",
  "message": "Ticket category deleted successfully"
}