PUT Impact

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

Use Case scenarios	Solution
Rename an Incident Impact	Update the `Text` field for the specified Impact record.
Activate or deactivate an Impact	Set `Active` to `true` or `false`.
Change the display order	Update `Sort_Order` to control the position of the Impact value.
Support configuration automation	Allow authorized integrations to update Impact master data programmatically.

Endpoint

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

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

Path Parameters

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

The endpoint contains the following fixed path values:

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

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

curl --location 'https://<host>/API/v1/Master/IM/Impact/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 Impact record is active.
`Text`	String	Yes	Display name or text value of the Impact record.
`Sort_Order`	Integer	Yes	Defines the display or processing order of the Impact record.

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

Sample Payload

{
  "Active": true,
  "Text": "Sample Impact Name",
  "Sort_Order": 0
}

Sample Request

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

Sample Request Details

Component	Value	Description
HTTP Method	`PUT`	Updates an existing Impact master record.
Endpoint URL	`https://<host>/API/v1/Master/IM/Impact/1001`	Specifies the API endpoint used to update the Impact record with record ID `1001`.
Host	`<host>`	Base URL of the target environment, such as Development, Test, or Production.
Module	`IM`	Identifies the Incident Management module.
Master Name	`Impact`	Identifies the Impact master entity.
Record ID	`1001`	Unique identifier of the Impact record to update.
Accept Header	`application/json`	Indicates that the client expects the API 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 Impact record.

Request Body Details

Field Name	Sample Value	Data Type	Description
Active	`true`	Boolean	Indicates whether the Impact record is active.
Text	`"Sample Impact Name"`	String	Specifies the updated display name of the Impact record.
Sort_Order	`0`	Integer	Specifies the display or processing order of the Impact record.

Sample Request Explanation

Attribute	Updated Value	Result
Impact Record ID	`1001`	Identifies the existing Impact record to update.
Impact Name	`"Sample Impact Name"`	Updates the display name of the Impact record.
Active Status	`true`	Keeps the Impact record active.
Sort Order	`0`	Sets the display or processing order of the Impact record to `0`.

The request updates the Impact record with ID 1001, changes its display name to Sample Impact Name, keeps the record active, and sets its sort order to 0.

Sample Success Response

HTTP 200 OK

{
  "message": "Master record updated successfully.",
  "data": {
    "success": true,
    "recordId": 1001,
    "displayName": "Impact",
    "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	Provides a message indicating that the update operation completed successfully.
data	Response object	Object	Contains information about the completed update operation.
data.success	`true`	Boolean	Indicates whether the Impact update operation succeeded.
data.recordId	`1001`	Integer	Identifies the Impact record updated by the request.
data.displayName	`"Impact"`	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 Impact record.
data.rowsAffected	`1`	Integer	Indicates the number of Impact records updated by the request.
executionTime	`0.0117173`	Number	Indicates the time taken to process the request, in seconds.

Success Response Explanation

Response Attribute	Returned Value	Meaning
Operation Status	`true`	Confirms the Impact record updated successfully.
Updated Record ID	`1001`	Identifies the Impact record affected by the request.
Master Entity	`"Impact"`	Confirms that the updated record belongs to the Impact 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 the update affected one Impact 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 Impact record with ID 1001, the operation affected one record, and the request completed in 0.0117173 seconds.

Error Responses

400 Bad Request

Returned when the payload is invalid, a required field is missing, or a supplied value fails validation.

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

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 Impact record.

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

404 Not Found

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

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

Documentation Index