> ## 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 Record > Updates a `Log` record. Only the fields you send are changed; the rest are left as they are. Send at least one field inside `data`. An empty update is rejected with a 400 and `At least one field must be provided to update`, and the body is validated before the record is looked up, so an empty update against an id that does not exist returns that 400 rather than a 404. ## OpenAPI ````yaml /developers/v1/openapi.json patch /api/v1/records/{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 ` 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/records/{id}: patch: tags: - Records summary: Update Record description: >- Updates a `Log` record. Only the fields you send are changed; the rest are left as they are. Send at least one field inside `data`. An empty update is rejected with a 400 and `At least one field must be provided to update`, and the body is validated before the record is looked up, so an empty update against an id that does not exist returns that 400 rather than a 404. operationId: updateRecord 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: data: type: object properties: type: type: string enum: - web - walk-in - phone - written/email request description: How the inquiry reached you. example: phone date: type: string description: When the inquiry happened. example: '2024-03-20' status: description: How far along the inquiry is. type: string enum: - open - in_progress - complete contactName: description: Full name of the person who made the inquiry. example: Jane Doe type: - string - 'null' contactEmail: description: Email address of the person who made the inquiry. example: jane.doe@example.com type: - string - 'null' contactPhone: description: Phone number of the person who made the inquiry. example: (555) 987-6543 type: - string - 'null' contactType: description: The caller's relationship to the property. example: homeowner anyOf: - type: string enum: - homeowner - property_owner - renter - surveyor - contractor - architect - insurance_agent - realtor - buyer - other - type: 'null' firmPanel: description: FIRM panel number. example: 17167C0033E type: - string - 'null' floodZone: description: Flood zone designation. example: AE anyOf: - type: string enum: - VE - AO - AE - A99 - AR - AR/AO - V - X - X500 - D - B - C - AH - A - A1 - A2 - A3 - A4 - A5 - A6 - A7 - A8 - A9 - A10 - A11 - A12 - A13 - A14 - A15 - A16 - A17 - A18 - A19 - A20 - A21 - A22 - A23 - A24 - A25 - A26 - A27 - A28 - A29 - A30 - V1 - V2 - V3 - V4 - V5 - V6 - V7 - V8 - V9 - V10 - V11 - V12 - V13 - V14 - V15 - V16 - V17 - V18 - V19 - V20 - V21 - V22 - V23 - V24 - V25 - V26 - V27 - V28 - V29 - V30 - X500 (LOMC) - X (LOMC) - OPEN WATER - type: 'null' bfe: description: Base Flood Elevation, sent as a string. example: '12.5' type: - string - 'null' baseFloodDepth: description: Base flood depth, sent as a string. example: '2' type: - string - 'null' insuranceInfoGiven: description: How insurance information was provided, if it was. example: verbally anyOf: - type: string enum: - verbally - handout - email - type: 'null' siteVisit: description: Whether a site visit took place. type: - boolean - 'null' propertyProtectionAdvice: description: Whether property protection advice was given. type: - boolean - 'null' financialAdvice: description: Whether financial advice was given. type: - boolean - 'null' coastalOrCBRS: description: Whether the property is in a coastal or CBRS area. type: - boolean - 'null' pastFlood: description: Whether the property has flooded before. type: - boolean - 'null' erosion: description: Whether erosion was raised as a concern. type: - boolean - 'null' requestedHelpWith: description: What the person asked for help with. example: Flood zone status inquiry type: - string - 'null' internalNotes: description: >- Notes kept internal to your staff. Send `null` to clear a field. type: - string - 'null' description: >- The log fields to change. Omitted fields are left as they are. externalSystemId: description: Your system's identifier for this log. example: LOG-2024-0320 type: - string - 'null' propertyId: description: UUID of the Forerunner property to attach the log to. example: a1b2c3d4-e5f6-4890-abcd-ef0123456789 type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ coordinates: type: array prefixItems: - type: number minimum: -90 maximum: 90 - type: number minimum: -180 maximum: 180 items: false minItems: 2 maxItems: 2 description: >- Location as a `[latitude, longitude]` pair in EPSG:4326 (WGS 84). example: - 39.7817 - -89.6501 recordType: type: string const: Log description: The record type being updated. Must be `Log` on v1. required: - recordType responses: '200': description: Success. `errors` is empty. content: application/json: schema: $ref: '#/components/schemas/V1UpdateRecordResponse' example: errors: [] record: id: c7d8e9f0-1a2b-4c4d-8e6f-7a8b9c0d1e2f externalSystemId: PDA-2024-0417 data: {} property: id: a1b2c3d4-e5f6-4890-abcd-ef0123456789 address: 123 Main St, Springfield, IL 62701 url: >- https://demoville.app.withforerunner.com/map?propertyId=a1b2c3d4-e5f6-4890-abcd-ef0123456789&tab=overview publicURL: >- https://demoville.withforerunner.com/properties/a1b2c3d4-e5f6-4890-abcd-ef0123456789 coordinates: - 39.7817 - -89.6501 '400': description: The request failed validation. `errors` names each field at fault. content: application/json: schema: anyOf: - $ref: '#/components/schemas/V1UpdateRecordResponse' - $ref: '#/components/schemas/APIResponse' example: errors: - message: Invalid UUID format for id parameter field: id record: 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. '404': description: No resource in your account matches that id. content: application/json: schema: $ref: '#/components/schemas/V1UpdateRecordResponse' example: errors: - message: Log not found for this account field: id record: null '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: V1UpdateRecordResponse: 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: [] record: anyOf: - $ref: '#/components/schemas/V1Record' - type: 'null' description: The updated record. Null when the update failed. required: - errors - record 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. V1Record: type: object properties: id: type: string description: UUID of the record in Forerunner. example: c7d8e9f0-1a2b-4c4d-8e6f-7a8b9c0d1e2f externalSystemId: description: >- Your system's identifier for this record, if one was supplied when it was created. example: PDA-2024-0417 type: - string - 'null' data: type: object propertyNames: type: string additionalProperties: {} description: >- The record's fields. The keys vary by record type and by how your community has configured that type. property: anyOf: - $ref: '#/components/schemas/V1Property' - type: 'null' description: >- The property this record is attached to, or null when it is not attached to one. required: - id - externalSystemId - data - property additionalProperties: false description: A record of a single record type. V1Property: type: object properties: id: type: string description: UUID of the property in Forerunner. example: a1b2c3d4-e5f6-4890-abcd-ef0123456789 address: description: >- The property's fully qualified address. Null for properties that have no address on file. example: 123 Main St, Springfield, IL 62701 type: - string - 'null' url: type: string description: >- Link to the property on the map in Forerunner. Requires an account to open. example: >- https://demoville.app.withforerunner.com/map?propertyId=a1b2c3d4-e5f6-4890-abcd-ef0123456789&tab=overview publicURL: description: >- Link to the property's public profile page. Null when the property is hidden from the public site. example: >- https://demoville.withforerunner.com/properties/a1b2c3d4-e5f6-4890-abcd-ef0123456789 type: - string - 'null' coordinates: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 description: '`[latitude, longitude]` in EPSG:4326 (WGS 84).' example: - 39.7817 - -89.6501 required: - id - address - url - publicURL - coordinates additionalProperties: false description: A property in Forerunner. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your account's API key, sent as `Authorization: Bearer `. 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.