> ## Documentation Index
> Fetch the complete documentation index at: https://withforerunner.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update SI/SD

> Updates an SI/SD record and recomputes the property's threshold warnings. Every field is optional, but send at least one.

`address`, `parcelId`, `coordinates`, and `externalSystemId` will not move the record — delete it and resubmit to change where it is attached.

Account-specific identifiers your community requires may be sent as extra top-level fields.

Updating an id that does not exist returns a 400 with `Improvement not found`, not a 404.



## OpenAPI

````yaml /developers/v1/openapi.json patch /api/v1/sisd/{id}
openapi: 3.1.0
info:
  title: Forerunner Integration API v1
  version: 1.0.0
  description: >-
    Read and write floodplain data in Forerunner. This is the v1 contract; each
    version is documented separately and evolves on its own.


    v1 is the current version. It covers files, properties, records, and SI/SD,
    and is the one to build against. Its record endpoints handle `Log` records
    only; use v2 for any other record type.


    Every request needs an `Authorization: Bearer <your API key>` header.


    List endpoints return 25 results per page; page through them with `page` and
    read `pageInfo` for the totals. Every JSON response carries an `errors`
    array, empty when the request succeeded; the `401`, `403`, and `429`
    responses are plain text or HTML instead.


    Develop against the staging server, which is a separate account with
    separate API keys and separate data.


    Requests are rate limited per IP at the CDN. A request over the limit is
    answered with a `429` and an HTML body, not the JSON error shape.
servers:
  - url: https://app.withforerunner.com
    description: Production
  - url: https://app.staging.withforerunner.com
    description: Staging, for development and testing
security:
  - bearerAuth: []
tags:
  - name: Files
    description: >-
      Upload, retrieve, and update documents such as Elevation Certificates and
      permits.
  - name: Properties
    description: Query the properties in your account.
  - name: Records
    description: >-
      Read, create, update, and delete `Log` records. Other record types are
      available on v2.
  - name: SI/SD
    description: >-
      Track substantial improvement and substantial damage against your
      community's thresholds.
paths:
  /api/v1/sisd/{id}:
    patch:
      tags:
        - SI/SD
      summary: Update SI/SD
      description: >-
        Updates an SI/SD record and recomputes the property's threshold
        warnings. Every field is optional, but send at least one.


        `address`, `parcelId`, `coordinates`, and `externalSystemId` will not
        move the record — delete it and resubmit to change where it is attached.


        Account-specific identifiers your community requires may be sent as
        extra top-level fields.


        Updating an id that does not exist returns a 400 with `Improvement not
        found`, not a 404.
      operationId: updateSISD
      parameters:
        - name: id
          in: path
          required: true
          description: UUID of the resource in Forerunner.
          schema:
            type: string
            format: uuid
          example: f8a3b2c1-d4e5-4789-abcd-ef0123456789
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - improvement
                    - damage
                  description: Whether this records an improvement or damage.
                  example: damage
                value:
                  type: number
                  minimum: 0
                  description: Cost of the improvement or damage, in dollars.
                  example: 125000
                propertyMarketValue:
                  description: >-
                    Market value of the structure before the improvement or
                    damage, in dollars.
                  example: 200000
                  type: number
                  minimum: 0
                description:
                  description: What the improvement or damage was. Send `null` to clear it.
                  example: Flood damage from March storm
                  type:
                    - string
                    - 'null'
                date:
                  type: string
                  description: >-
                    When the improvement or damage occurred. Accepts ISO 8601
                    (`2024-03-15`) or `MM/DD/YYYY` (`03/15/2024`).
                  example: '2024-03-15'
              additionalProperties: {}
      responses:
        '200':
          description: Success. `errors` is empty.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1UpdateSISDResponse'
              example:
                errors: []
                sisd:
                  id: a1b2c3d4-e5f6-4890-abcd-ef1234567890
                property:
                  warnings:
                    - message: >-
                        The damage costs recorded for this property meet or
                        exceed your community's Substantial Damage threshold.
                        Further action might be necessary to ensure compliance.
        '400':
          description: The request failed validation. `errors` names each field at fault.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/V1UpdateSISDResponse'
                  - $ref: '#/components/schemas/APIResponse'
              example:
                errors:
                  - message: Invalid UUID format for id parameter
                    field: id
                sisd: null
                property: null
        '401':
          description: >-
            Missing or invalid API key. The body is plain text, not the JSON
            error shape.
        '403':
          description: >-
            Blocked by our web application firewall, which answers with an HTML
            body rather than the JSON error shape. Most often caused by a client
            sending a `PostmanRuntime`, `python-requests`, or `HeadlessChrome`
            `User-Agent`; clear that header and retry.
        '429':
          description: >-
            Too many requests from your IP. Rate limiting is applied at the CDN,
            so the body is HTML rather than the JSON error shape. Back off and
            retry.
components:
  schemas:
    V1UpdateSISDResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
          description: >-
            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:
          anyOf:
            - $ref: '#/components/schemas/V1SISDReference'
            - type: 'null'
          description: The updated SI/SD record. Null when the update failed.
        property:
          anyOf:
            - $ref: '#/components/schemas/V1SISDPropertyWarnings'
            - type: 'null'
          description: Threshold warnings for the property this record was saved against.
      required:
        - errors
        - sisd
        - property
      additionalProperties: false
    APIResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
          description: >-
            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: []
      required:
        - errors
      additionalProperties: false
      description: Every response carries an `errors` array alongside its resource fields.
    APIError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of what went wrong.
          example: Required
        field:
          type: string
          description: The request field that caused the error, as a dot-separated path.
          example: data.type
      required:
        - message
        - field
      additionalProperties: false
      description: A single validation or processing failure.
    V1SISDReference:
      type: object
      properties:
        id:
          type: string
          description: UUID of the SI/SD record.
          example: a1b2c3d4-e5f6-4890-abcd-ef1234567890
      required:
        - id
      additionalProperties: false
    V1SISDPropertyWarnings:
      type: object
      properties:
        warnings:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                description: The warning text.
                example: >-
                  The damage costs recorded for this property meet or exceed
                  your community's Substantial Damage threshold. Further action
                  might be necessary to ensure compliance.
            required:
              - message
            additionalProperties: false
          description: >-
            Threshold warnings raised for the property after this record was
            saved. Empty when no threshold was met.
      required:
        - warnings
      additionalProperties: false
      description: Compliance warnings for the property this record was saved against.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.