Skip to main content
​
POST
endpoint
/api/v1/logs
Create a new public assistance log entry in Forerunner.

​
Body Parameters

​
type
string
required
Type of interaction. Valid values:
  • web
  • walk_in
  • phone
  • written_or_email_request
​
date
string
required
Date of the interaction in MM/DD/YYYY format (e.g., 03/20/2024)
​
status
string
required
Current status of the log entry: open, complete, or in_progress
​
contactInformation
object
Information about the person making the inquiry
​
discussion
object
Details about the interaction
​
address
string
Street address related to the inquiry
​
parcelId
string
Parcel ID related to the inquiry
​
coordinates
array
Two-element array [latitude, longitude] in EPSG:4326 format
[39.78, -89.65]
At least one of address, parcelId, or coordinates is required for Forerunner to properly geolocate the log.

​
Response

​
log
object
​
errors
array
Array of error objects. See Errors.
curl -X POST https://app.withforerunner.com/api/v1/logs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "phone",
    "date": "03/20/2024",
    "status": "complete",
    "contactInformation": {
      "name": "Jane Doe",
      "phone": "(555) 987-6543",
      "email": "jane.doe@example.com"
    },
    "discussion": {
      "siteVisit": false,
      "insuranceInfoGiven": "verbally",
      "requestedHelpWith": "Flood zone status inquiry",
      "internalNotes": "Provided information about flood zone AE designation and explained EC submission process."
    },
    "address": "456 Oak Ave, Springfield, IL"
  }'

{
  "log": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789"
  },
  "errors": []
}