Update order risk record

PUT 
/openapi/2025-06/orders/:order_id/risks/:id

Modifies the risk level, detail reasons, or custom properties of an existing risk record on the order. The record is located by its id; the order itself is unchanged.

Request

Path Parameters

order_id stringrequired

Order ID

id stringrequired

Order risk record ID

application/json

Body

Bodyrequired

risk objectrequired
Order risk update parameters
levelstring
Updated risk level for the order:
• low: low risk
• medium: medium risk
• high: high risk
detailsstring[]
Updated list of risk detail reasons
properties object
Custom properties for the order risk, as key-value pairs
property name*string

Example

{
  "risk": {
    "level": "string",
    "details": [
      "string"
    ],
    "properties": {}
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

risk object

Order risk record

idstring

Order risk record ID

order_idstring

Identifier of the order this risk record is associated with

levelstring

Risk level of the order:

• low: low risk
• medium: medium risk
• high: high risk

detailsstring[]

List of risk detail reasons explaining why the risk was flagged

properties object

Custom properties associated with the order risk, as key-value pairs

property name*string

created_atstring

Time when the risk record was created (e.g., 2018-11-02T12:30:10Z)

updated_atstring

Time when the risk record was last updated (e.g., 2018-11-02T12:30:10Z)

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "risk": {
      "id": "string",
      "order_id": "string",
      "level": "string",
      "details": [
        "string"
      ],
      "properties": {},
      "created_at": "string",
      "updated_at": "string"
    }
  }
}