Update an issue category

Updates an issue category by the given id.

put

Path parameters

idstringRequired

The id of the issue category.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

The issue category of the dto transfer when creating or updating.

groupCodestring | nullableOptional

The group code of the issue category. If null, it is a root issue category.

codestring · min: 1Required

The code of the issue category.

namestring · min: 1Required

The name of the issue category.

descriptionstring | nullableOptional

The description of the issue category.

tagsstring | nullableOptional

The tags of the issue category.

suggestionUrlstring · uri | nullableOptional

The links of the issue category.

Example: https://www.example.com/suggestion

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/issue-categories/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "groupCode": "text",
  "code": "text",
  "name": "text",
  "description": "text",
  "tags": "text",
  "suggestionUrl": "https://www.example.com/suggestion"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "groupCode": "REPORT-PROBLEM",
    "code": "USER-REPORT",
    "name": "User Report",
    "description": "This is a user report",
    "isSystem": false,
    "tags": "#Tags",
    "suggestionURL": "https://www.example.com/suggestion",
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}