PUT Classification

The PUT Classification Incident Master API updates an existing Classification master record in the Incident Management (IM) module. You identify the target Classification record by its unique record ID, and the request payload contains the updated values for the record.

Use Case scenarios	Solution
Rename an Incident Classification	Update the `Text` field for the specified Classification record.
Activate or deactivate a Classification	Set `Active` to `true` or `false`.
Correct Classification master data	Update an existing record to reflect the correct business terminology.
Support configuration automation	Allow authorized integrations to update Classification master data programmatically.

Update a Classification Master Record

Endpoint

PUT /API/v1/Master/IM/Classification/{recordId}

Updates an existing Classification master record.

Path Parameters

Parameter	Data Type	Required	Description	Example
recordId	Integer	Yes	Unique identifier of the Classification record to update.	1001

Fixed Path Values

Path Value	Description
IM	Module code for Incident Management.
Classification	Master name for the Classification entity.

Note Before updating a Classification record, system retrieves the Classification metadata to understand the expected payload structure and field definitions using GET /API/v1/Master/IM/Classification/metadata?sections=update.

Request Headers

Header	Value	Required	Description
Accept	application/json	Yes	Specifies the expected response format.
Content-Type	application/json	Yes	Indicates the request body is JSON.
X-Api-Key	`<API_KEY>`	Yes	API key used to authenticate the request.

Request Body

Provide the Classification values to update in JSON format.

Fields

Field Name	Description	Data Type	Required	Constraints	Example
Active	Indicates whether the Classification record is active.	Boolean	Yes	Accepted values are `true` or `false`.	`true`
Text	Display name of the Classification record.	String	Yes	Cannot be null or empty. Maximum supported length is 50 characters. Do not use unsupported special characters. Duplicate Classification names are not allowed.	`"Service Request"`

Sample Payload

{
  "Active": true,
  "Text": "Service Request"
}

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/Classification/1001' \
--request PUT \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <API_KEY>' \
--data-raw '{
  "Active": true,
  "Text": "Service Request"
}'

Sample Request Breakdown

Component	Value	Description
HTTP Method	PUT	Updates an existing Classification master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Classification/1001`	API endpoint used to update the Classification record with ID `1001`.
Host	`<host>`	Base URL of the target environment (Development, Test, or Production).
Record ID	`1001`	Unique identifier of the Classification record to update.
Accept Header	`application/json`	Indicates that the client expects the response in JSON format.
Content-Type Header	`application/json`	Specifies that the request body uses JSON format.
X-Api-Key Header	`<API_KEY>`	API key used to authenticate the request.
Request Body	JSON payload	Contains the Classification values to update.

Request Body Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Specifies whether the Classification record is active.
Text	`Service Request`	String	Display name of the Classification.

Example Explanation

Attribute	Updated Value	Result
Classification Record ID	`1001`	Identifies the Classification record to update.
Classification Name	`Service Request`	Updates the display name of the Classification.
Active Status	`true`	Keeps the Classification active.

The request updates the Classification record with ID 1001, changes its name to Service Request, and keeps the record active.

Sample Success Response

{
  "message": "Master record updated successfully.",
  "data": {
    "success": true,
    "recordId": 1001,
    "displayName": "Classification",
    "moduleCode": "IM",
    "operation": "UPDATE",
    "rowsAffected": 1
  },
  "executionTime": 0.0117173
}

Response Fields

Field	Description	Data Type
message	Status message indicating the result of the operation.	String
success	Indicates whether the update operation succeeded.	Boolean
recordId	Identifier of the updated Classification record.	Integer
displayName	Name of the master entity updated.	String
moduleCode	Module associated with the master record.	String
operation	Operation performed.	String
rowsAffected	Number of records updated.	Integer
executionTime	Time taken to process the request in seconds.	Number

400 Bad Request

Returned when the request payload is invalid, a required field is missing, or a field contains an unsupported value.

Validation Scenarios

Scenario	Description
Missing required field	You omit the `Text` field or it contains an empty value.
Invalid data type	A field contains a value that does not match the expected data type.
Unsupported special characters	The Classification name contains characters that are not supported by validation rules.
Classification name exceeds max length	The `Text` value exceeds the max supported limit of 50 characters.
Duplicate Classification name	The updated Classification name already exists and duplicate values are not permitted.

Example: Missing Required Field

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Text is required."
  ]
}

Example: Unsupported Special Characters

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Classification name contains unsupported special characters."
  ]
}

Example: Maximum Length Exceeded

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Classification name cannot exceed 50 characters."
  ]
}

Example: Duplicate Classification Name

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "A Classification with the specified name already exists."
  ]
}

401 Unauthorized

Returned when the API key is missing or invalid.

{
  "status": 401,
  "error": "Unauthorized",
  "message": "Invalid or missing API credentials."
}

403 Forbidden

Returned when the authenticated client does not have permission to update the Classification record.

{
  "status": 403,
  "error": "Forbidden",
  "message": "You do not have permission to perform this action."
}

404 Not Found

Returned when the specified Classification record does not exist or the API endpoint URL is incorrect.

{
  "status": 404,
  "error": "Not Found",
  "message": "The specified master record was not found."
}

Documentation Index