Skip to main content
PATCH
Update SI/SD

Authorizations

Authorization
string
header
required

Your account's API key, sent as Authorization: Bearer <your API key>. Keys are issued per environment, so a staging key will not work against production.

Path Parameters

id
string<uuid>
required

UUID of the resource in Forerunner.

Body

application/json
type
enum<string>

Whether this records an improvement or damage.

Available options:
improvement,
damage
Example:

"damage"

value
number

Cost of the improvement or damage, in dollars.

Required range: x >= 0
Example:

125000

propertyMarketValue
number

Market value of the structure before the improvement or damage, in dollars.

Required range: x >= 0
Example:

200000

description
string | null

What the improvement or damage was. Send null to clear it.

Example:

"Flood damage from March storm"

date
string

When the improvement or damage occurred. Accepts ISO 8601 (2024-03-15) or MM/DD/YYYY (03/15/2024).

Example:

"2024-03-15"

{key}
any

Response

Success. errors is empty.

errors
object[]
required

Empty when the request succeeded. Otherwise one entry per failure, and the resource fields on the response are empty: null for single resources, [] for lists, with pageInfo omitted.

Example:
sisd
object | null
required

The updated SI/SD record. Null when the update failed.

property
object | null
required

Threshold warnings for the property this record was saved against.