API ReferenceRisk

Update Risk

Updates an existing Risk. Only the fields provided in the request body will be updated. Fields omitted from the request will remain unchanged. Authorization is enforced to ensure the caller has access to modify the specified Risk.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

riskIdstringRequiredformat: "uuid"
The id of the risk

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The fields to update
namestring or nullOptional
The common name of this Risk.
dueDatestring or nullOptionalformat: "date"
The date when this risk is expected to be resolved.
percentCompleteinteger or nullOptional0-100

Percentage completion (0–100).

priorityinteger or nullOptional
Priority of the risk.
impactinteger or nullOptional
The potential effect of the risk.
likelihoodinteger or nullOptional
Probability of the risk occurring.
responseIdinteger or nullOptional
Planned or implemented response. Avoid it, Mitigate, Transfer, Accept
resolutionstring or nullOptional
Actions taken or planned to address the risk.
descriptionstring or nullOptional
Additional comments or observations.
assigneeslist of strings or nullOptional
Users assigned to the risk. Replaces existing assignments when provided.
tagIdslist of strings or nullOptional
Tags applied to the risk. Replaces existing tags when provided.
riskTypeIdinteger or nullOptional

The type of risk. Risk = 1 Assumption = 2 Issue = 3 Dependency = 4 Change = 5

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or nullRead-only

True if the API call succeeded; false otherwise.

hasErrorboolean or nullRead-only
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
Represents a potential threat or uncertainty that could impact a project, system, or process. Contains information such as its likelihood, impact, response, and resolution details.