API 2026-11-01 Draft contract. Webhook payloads are final for this version; the REST API is in design and not live yet.

Communities & properties

Your system pushes communities and properties so inspectors drive with the right map, and so every payload carries your own ids.

How it flows

  1. You push each community with its cure days and notice ladder.
  2. You push properties in bulk, keyed by your own account id.
  3. Every payload HOACraft sends then carries your external_id, so you never match on addresses.

Endpoints

Planned REST API, not live yet. Base URL https://sandbox.api.hoacraft.com/v1, Authorization: Bearer <key>. See basics.

Create or update a community

PUT/communities/{communityId}

Parameters

communityIdrequiredpath · string

Request body

namerequiredstring
citystring
statestring
cure_daysintegerDefault days to cure before re-check.
notice_stagesarray of string e.g. ["Courtesy notice","First violation notice","Final notice before fine"]

Responses

200UpdatedCommunity
201CreatedCommunity
422Validation failedError

Example request

curl -X PUT "https://sandbox.api.hoacraft.com/v1/communities/willow-creek" \
  -H "Authorization: Bearer $HOACRAFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "city": "string",
  "state": "string",
  "cure_days": 1,
  "notice_stages": [
    "Courtesy notice",
    "First violation notice",
    "Final notice before fine"
  ]
}'
Example response
{
  "name": "string",
  "city": "string",
  "state": "string",
  "cure_days": 1,
  "notice_stages": [
    "Courtesy notice",
    "First violation notice",
    "Final notice before fine"
  ],
  "id": "string"
}

Bulk upsert properties (up to 1,000 per call)

PUT/communities/{communityId}/properties

Rows are matched on external_id. Properties not in the call are left alone.

Parameters

communityIdrequiredpath · string

Request body

propertiesrequiredarray of PropertyInput up to 1000 items

Responses

200Per-row outcomeobject
422Validation failedError

Example request

curl -X PUT "https://sandbox.api.hoacraft.com/v1/communities/willow-creek/properties" \
  -H "Authorization: Bearer $HOACRAFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "properties": [
    {
      "external_id": "string",
      "lot_number": "string",
      "address": "string",
      "occupied": true,
      "owner_name": "string",
      "lat": 0.0,
      "lng": 0.0
    }
  ]
}'
Example response
{
  "created": 1,
  "updated": 1,
  "errors": [
    {
      "index": 1,
      "external_id": "string",
      "message": "string"
    }
  ]
}