PUT Pending Reason

The PUT Pending Reason Incident Master API updates an existing Pending Reason master record in the Incident Management (IM) module. Authorized administrators, integrations, and automation tools can change Pending Reason records without using the application UI.

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

Endpoint

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

The endpoint identifies the Pending Reason record by its unique record ID.

Path Parameters

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

The endpoint contains the following fixed path values:

Path Value	Description
`IM`	Module code for Incident Management.
`PendingReason`	Master name for the Pending Reason entity.

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

curl --location 'https://<host>/API/v1/Master/IM/PendingReason/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.

Request Body Fields

Field	Data Type	Required	Description
`Active`	Boolean	Yes	Indicates whether the Pending Reason record is active.
`Text`	String	Yes	Display name or text value of the Pending Reason record.

Sample Payload

{
  "Active": true,
  "Text": "Sample Pending Reason"
}

Sample Payload Field Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Pending Reason record is active and available for use.
Text	`"Sample Pending Reason"`	String	Specifies the display name of the Pending Reason record.

Sample Payload Explanation

Attribute	Value	Explanation
Active Status	`true`	Keeps the Pending Reason record active and available for use.
Pending Reason Name	`"Sample Pending Reason"`	Sets the display name of the Pending Reason record.

Sample Request

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

The sample request updates the Pending Reason record whose record ID is 1001.

Sample Request Details

Component	Value	Description
HTTP Method	`PUT`	Updates an existing Pending Reason master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/PendingReason/1001`	API endpoint used to update the Pending Reason 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	`PendingReason`	Identifies the Pending Reason master entity.
Record ID	`1001`	Unique identifier of the Pending Reason 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 approve the request.
Request Body	JSON payload	Contains the updated values for the specified Pending Reason record.

Request Body Details

Field Name	Sample Value	Data Type	Required	Description
Active	`true`	Boolean	Yes	Keeps the Pending Reason record active and available for use.
Text	`"Sample Pending Reason"`	String	Yes	Updates the display name of the Pending Reason record.

Sample Request Explanation

Attribute	Updated Value	Result
Pending Reason Record ID	`1001`	Identifies the existing Pending Reason record to update.
Active Status	`true`	Keeps the Pending Reason record active.
Pending Reason Name	`"Sample Pending Reason"`	Updates the display name of the Pending Reason record.

The request updates the Pending Reason record with ID 1001, changes its display name to Sample Pending Reason, and keeps the record active.

Sample Success Response

HTTP 200 OK

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

A successful request updates the specified Pending Reason record and returns details about the completed update operation.

Sample Success Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Master record updated successfully."`	String	Provides a message confirming successful update of the Pending Reason record.
data	Response object	Object	Contains details about the completed update operation.
data.success	`true`	Boolean	Indicates whether the Pending Reason update operation succeeded.
data.recordId	`1001`	Integer	Identifies the Pending Reason record updated by the request.
data.displayName	`"PendingReason"`	String	Identifies the master entity updated.
data.moduleCode	`"IM"`	String	Identifies the Incident Management module associated with the updated record.
data.operation	`"UPDATE"`	String	Identifies the operation performed on the Pending Reason record.
data.rowsAffected	`1`	Integer	Indicates the number of Pending Reason 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 Pending Reason update completed successfully.
Operation Status	`true`	Confirms that the Pending Reason update operation succeeded.
Updated Record ID	`1001`	Identifies the Pending Reason record affected by the request.
Master Entity	`"PendingReason"`	Confirms that the updated record belongs to the Pending Reason 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 update changed one Pending Reason 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 update operation successfully modified the Pending Reason record with ID 1001 and affected one record.

Error Responses

400 Bad Request

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

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