Modifying catastrophes

Use the following endpoint to modify a catastrophe:

  • PATCH /admin/v1/catastrophes/{catastropheId}
You can modify the following fields:
  • active
  • catastropheNumber
  • catastropheValidFrom
  • catastropheValidTo
  • comments
  • name
  • scheduleBatch
  • type/code
Note: The code within type is a string that represents a TypeKey from a TypeList of available codes, so you can only use a value enumerated in that list. The only values you can use are iso or internal.

For example, the following request modifies the date range for catastrophe xc:SAw_jS2RygUX4uS9idwqV.

Command
PATCH /admin/v1/catastrophes/xc:SAksedABpXZrTAczt7MRU
Request

{
    "data": {
        "attributes": {
            "catastropheValidFrom": "2024-03-25T00:00:00.000Z",
            "catastropheValidTo": "2024-03-29T00:00:00.000Z"
        }
    }
}

The API responds with the updated catastrophe.

Response


{
    "data": 
        {
            "attributes": {
                "active": false,
                "catastropheNumber": "24X",
                "catastropheValidFrom": "2024-03-25T00:00:00.000Z",
                "catastropheValidTo": "2024-03-29T00:00:00.000Z",
                "comments": "Catastrophe Details for Hurricane Example",
                "description": "Hurricane Example",
                "id": "xc:SAw_jS2RygUX4uS9idwqV",
                "name": "Hurricane Example",
                "scheduleBatch": false,
                "type": {
                    "code": "iso",
                    "name": "ISO"
                }
            }
        }
}