Skip to main content
​
POST
endpoint
/api/v1/records
Create a new record in Forerunner. The accepted body fields and response data schema depend on the recordType. Logs track contact inquiries, document your responses, and maintain records for CRS documentation.
This endpoint currently only supports creating records with a recordType of Log.

​
Body Parameters

​
recordType
string
required
Must be Log.
​
externalSystemId
string
Unique identifier from your system
​
propertyId
string
UUID of an existing property in Forerunner. When provided, the record is associated directly with this property instead of geocoding the address.
​
coordinates
array
Two-element array [latitude, longitude] in EPSG:4326 format. Used to resolve a property when propertyId and coordinates are not provided.
​
data
object
required
Log-specific fields.
​
data.type
string
required
How the contact reached out. Valid values:
  • web
  • walk-in
  • phone
  • written/email request
​
data.date
string
required
Date of the inquiry. Accepts any date string that can be parsed as a date (e.g., 2024-03-20, 2024-03-20T14:30:00Z).
​
data.address
string
required
Fully qualified street address in the format: {streetNumber} {streetName} {streetPostfix}, {city}, {state} {zip} (e.g., 123 Main St, Springfield, IL 62701). Forerunner uses this to associate the log with a property when propertyId and coordinates are not provided.
​
data.status
string
Current status of the log: open, in_progress, or complete. Defaults to open.
​
data.contactName
string
Full name of the contact
​
data.contactEmail
string
Email address for the contact
​
data.contactPhone
string
Phone number for the contact
​
data.contactType
string
Relationship of the contact to the property. Valid values:
  • homeowner
  • property_owner
  • renter
  • surveyor
  • contractor
  • architect
  • insurance_agent
  • realtor
  • buyer
  • other
​
data.firmPanel
string
FIRM panel number for the property (e.g., 17167C0033E). Auto-computed from the property’s coordinates if omitted.
​
data.floodZone
string
Flood zone designation for the property. Common values include AE, VE, X, AO, A, AH, and others. Auto-computed from the property’s coordinates if omitted.
​
data.bfe
string
Base Flood Elevation value as a string (e.g., "12.5"). Auto-computed from the property’s coordinates if omitted.
​
data.baseFloodDepth
string
Base flood depth value as a string. Auto-computed from the property’s coordinates if omitted.
​
data.insuranceInfoGiven
string
How insurance information was provided to the contact: verbally, handout, or email
​
data.siteVisit
boolean
Whether a site visit occurred
​
data.propertyProtectionAdvice
boolean
Whether property protection advice was given to the contact
​
data.financialAdvice
boolean
Whether financial advice was given to the contact
​
data.coastalOrCBRS
boolean
Whether the property is in a coastal or CBRS area. Auto-computed from the property’s coordinates if omitted.
​
data.pastFlood
boolean
Whether the property has experienced past flooding
​
data.erosion
boolean
Whether erosion is a concern for the property
​
data.requestedHelpWith
string
Description of what the contact requested help with
​
data.internalNotes
string
Internal notes about the interaction

​
Response

​
record
object
The created record
​
errors
array
Array of error objects. See Errors.
curl -X POST https://app.withforerunner.com/api/v1/records \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recordType": "Log",
    "data": {
      "type": "phone",
      "date": "2024-03-20",
      "status": "complete",
      "address": "456 Oak Ave, Springfield, IL",
      "contactName": "Jane Doe",
      "contactPhone": "(555) 987-6543",
      "contactEmail": "jane.doe@example.com",
      "contactType": "homeowner",
      "insuranceInfoGiven": "verbally",
      "siteVisit": false,
      "requestedHelpWith": "Flood zone status inquiry"
    }
  }'

{
  "record": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789",
    "externalSystemId": null,
    "data": {
      "date": "2024-03-20T00:00:00.000Z",
      "status": "complete",
      "type": "phone",
      "contactName": "Jane Doe",
      "contactEmail": "jane.doe@example.com",
      "contactPhone": "(555) 987-6543",
      "contactType": "homeowner",
      "address": "456 Oak Ave, Springfield, IL",
      "firmPanel": null,
      "floodZone": null,
      "bfe": null,
      "baseFloodDepth": null,
      "insuranceInfoGiven": "verbally",
      "siteVisit": false,
      "propertyProtectionAdvice": null,
      "financialAdvice": null,
      "coastalOrCBRS": null,
      "pastFlood": null,
      "erosion": null,
      "requestedHelpWith": "Flood zone status inquiry",
      "internalNotes": null,
      "sharedViaEmail": false,
      "viaPublicSite": false,
      "createdBy": null
    },
    "property": {
      "id": "f0e1d2c3-b4a5-6789-0fed-cba987654321",
      "address": "456 Oak Ave, Springfield, IL 62704",
      "coordinates": [39.7637, -89.6688],
      "url": "https://demoville.app.withforerunner.com/map?lat=39.7637&lng=-89.6688",
      "publicURL": "https://demoville.withforerunner.com/properties/f0e1d2c3-b4a5-6789-0fed-cba987654321"
    }
  },
  "errors": []
}