PUT Priority

The PUT Priority Incident Master API updates an existing Priority master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can change Priority, SLA, display, and ordering values without using the application UI.

Use Case scenarios	Solution
Rename or describe an Incident Priority	Update `Text`, `Text_Display`, or `Description`.
Activate or deactivate a Priority	Set `Active` to `true` or `false`.
Revise response and resolution targets	Update the response and resolution SLA values in minutes.
Configure excluded SLA days	Update the response and resolution skip-day values.
Change the display order	Update `Sort_Order` to control the position of the Priority value.
Support configuration automation	Allow authorized integrations to update Priority master data programmatically.

Endpoint

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

The endpoint identifies the Priority record by its unique record ID.

Path Parameters

Parameter	Data Type	Required	Description	Example
`recordId`	Integer or string	Yes	Unique identifier of the Priority record to update.	`1001`

The endpoint contains the following fixed path values:

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

Note Before updating a Priority record, system retrieves its update metadata to review required fields, supported fields, payload structure, validation constraints, and applicable endpoint. GET /API/v1/Master/IM/Priority/metadata?sections=update.

curl --location 'https://<host>/API/v1/Master/IM/Priority/metadata?sections=update' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: <API_KEY>'

Request Headers

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

Note: Review the update metadata response to confirm field requirements and validation constraints for the target environment.

Sample Payload

{
  "Active": true,
  "Description": "Sample Description",
  "Skip_Days_For_Resolution_SLA": 0,
  "Resolution_SLA_In_Minutes": 0,
  "Skip_Days_For_Response_SLA": 0,
  "Response_SLA_In_Minutes": 0,
  "Text_Display": "Sample Priority Display Name",
  "Text": "Sample Priority Name",
  "Sort_Order": 0
}

Request Body Fields

Field	Data Type	Required	Description
`Active`	Boolean	Yes	Indicates whether the Priority record is active.
`Description`	String	Yes	Description of the Priority and its intended use.
`Skip_Days_For_Resolution_SLA`	Integer	Yes	Number of days excluded from resolution SLA calculations.
`Resolution_SLA_In_Minutes`	Integer	Yes	Resolution SLA duration in minutes.
`Skip_Days_For_Response_SLA`	Integer	Yes	Number of days excluded from response SLA calculations.
`Response_SLA_In_Minutes`	Integer	Yes	Response SLA duration in minutes.
`Text_Display`	String	Yes	Formatted display name of the Priority.
`Text`	String	Yes	Name or text value of the Priority.
`Sort_Order`	Integer	Yes	Display or processing order of the Priority record.

Sample Request

curl --location 'https://<host>/API/v1/Master/IM/Priority/1001' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <API_KEY>' \
  --data-raw '{
    "Active": true,
    "Description": "Sample Description",
    "Skip_Days_For_Resolution_SLA": 0,
    "Resolution_SLA_In_Minutes": 0,
    "Skip_Days_For_Response_SLA": 0,
    "Response_SLA_In_Minutes": 0,
    "Text_Display": "Sample Priority Display Name",
    "Text": "Sample Priority Name",
    "Sort_Order": 0
  }'

Sample Request Details

Component	Value	Description
HTTP Method	`PUT`	Updates an existing Priority master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Priority/1001`	Specifies the API endpoint used to update the Priority record with record ID `1001`.
Host	`<host>`	Base URL of the target environment, such as Development, Test, or Production.
API Version	`v1`	Identifies Version 1 of the API.
Resource Group	`Master`	Identifies the Master Data API resource group.
Module	`IM`	Identifies the Incident Management module.
Master Name	`Priority`	Identifies the Priority master entity.
Record ID	`1001`	Unique identifier of the Priority record to update.
Accept Header	`application/json`	Indicates that the client expects the response in JSON format.
Content-Type Header	`application/json`	Indicates that the request body contains JSON data.
X-Api-Key Header	`<API_KEY>`	API key used to authenticate and authorize the request.
Request Body	JSON payload	Contains the updated values for the specified Priority record.

Sample Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Keeps the Priority record active and available for use.
Description	`"Sample Description"`	String	Yes	Sets the description of the Priority and explains its intended use.
Skip_Days_For_Resolution_SLA	`0`	Integer	Yes	Specifies the number of days excluded from the resolution SLA calculation.
Resolution_SLA_In_Minutes	`0`	Integer	Yes	Sets the resolution SLA duration in minutes.
Skip_Days_For_Response_SLA	`0`	Integer	Yes	Specifies the number of days excluded from the response SLA calculation.
Response_SLA_In_Minutes	`0`	Integer	Yes	Sets the response SLA duration in minutes.
Text_Display	`"Sample Priority Display Name"`	String	Yes	Sets the formatted display name of the Priority record.
Text	`"Sample Priority Name"`	String	Yes	Sets the name or text value of the Priority record.
Sort_Order	`0`	Integer	Yes	Sets the display or processing order of the Priority record.

Sample Request Explanation

Attribute	Updated Value	Result
Priority Record ID	`1001`	Identifies the existing Priority record to update.
Active Status	`true`	Keeps the Priority record active.
Description	`"Sample Description"`	Updates the description of the Priority record.
Resolution SLA Skip Days	`0`	Specifies that no days are excluded from the resolution SLA calculation.
Resolution SLA Duration	`0` minutes	Sets the resolution SLA duration to zero minutes.
Response SLA Skip Days	`0`	Specifies that no days are excluded from the response SLA calculation.
Response SLA Duration	`0` minutes	Sets the response SLA duration to zero minutes.
Priority Display Name	`"Sample Priority Display Name"`	Updates the formatted display name of the Priority.
Priority Name	`"Sample Priority Name"`	Updates the name of the Priority record.
Sort Order	`0`	Sets the display or processing order of the Priority record to zero.

The request updates the Priority record with ID 1001, keeps the record active, updates its description and display values, sets the response and resolution SLA values, and assigns a sort order of 0.

Sample Success Response

HTTP 200 OK

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

Sample Success Response Details

Field Name	Sample Value	Data Type	Description
message	`"Master record updated successfully."`	String	Confirms that the API successfully updated the Priority record.
data	Response object	Object	Contains information about the completed update operation.
data.success	`true`	Boolean	Indicates whether the Priority update operation succeeded.
data.recordId	`1001`	Integer	Identifies the Priority record updated by the request.
data.displayName	`"Priority"`	String	Identifies the master entity updated by the request.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the updated record.
data.operation	`"UPDATE"`	String	Identifies the operation performed on the Priority record.
data.rowsAffected	`1`	Integer	Indicates the number of Priority records updated by the request.
executionTime	`0.0117173`	Number	Indicates the time taken to process the request, in seconds.

Sample Success Response Explanation

Response Attribute	Returned Value	Meaning
HTTP Status	`200 OK`	Indicates that the API successfully processed the request.
Response Message	`"Master record updated successfully."`	Confirms that the master record update completed successfully.
Operation Status	`true`	Confirms that the Priority update operation succeeded.
Updated Record ID	`1001`	Identifies the Priority record affected by the request.
Master Entity	`"Priority"`	Confirms that the updated record belongs to the Priority master.
Module	`"IM"`	Confirms that the record belongs to the Incident Management module.
Operation	`"UPDATE"`	Confirms that the API performed an update operation.
Rows Affected	`1`	Confirms that the request updated one Priority record.
Execution Time	`0.0117173` seconds	Reports the time taken to process the update request.

A successful request returns HTTP 200 OK. The response confirms that the API successfully updated the Priority record with ID 1001 and that the operation affected one record.

The sample request updates the Priority record whose record ID is 1001.

Error Responses

400 Bad Request

{
  "status": 400,
  "error": "Bad Request",
  "message": "Invalid request payload.",
  "details": [
    "Text is required.",
    "Resolution_SLA_In_Minutes must be a valid integer."
  ]
}

401 Unauthorized

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

403 Forbidden

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

404 Not Found

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

Documentation Index