API ReferenceAHJs

Update AHJ

Update custom property values on an AHJ. The body custom map is keyed by property keyName — fetch the available keys via GET /properties?record_type=ahj.

Built-in AHJ fields (under Community Data in the UI) are read-only and cannot be updated through this endpoint.

Pass null to clear a value.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.
custommap from strings to anyRequired

Custom field values keyed by property keyName. Pass null to clear a value. Unknown keyNames are rejected with a 400 — fetch valid keys via GET /properties?record_type=ahj.

Response

AHJ updated successfully
idinteger
Unique identifier.
uuidstring or null

AHJID UUID (when known).

namestring

Full AHJ name (e.g. “City of San Francisco”).

typeenum or null
Jurisdiction type.
countrystring

Two-letter country code (e.g. “US”).

statestring or null

Two-letter state code (e.g. “CA”).

stateNamestring or null

Full state name (e.g. “California”).

parentCountystring or null

For sub-county jurisdictions, the containing county name.

geoIdstring or null
US Census TIGER GEOID for the boundary.
ahjRegistryCodestring or null

AHJ Registry composite code (e.g. “TX-4805000”).

isActiveboolean
Whether this AHJ is currently active in the catalog.
isPrivateboolean or null

True for company-private jurisdictions, false for global catalog entries.

companyIdinteger or null
For private jurisdictions, the owning company ID.
pointOfContactstring or null
submissionMethodstring or null

How permit submissions are accepted (online, in-person, etc.).

emailslist of strings
phoneslist of strings
addressstring or null
websitestring or null
portalstring or null
Permit portal URL.
turnaroundinteger or null
Typical permit turnaround in days.
feesstring or null
notesstring or null
permitSubmissionNotesstring or null
buildingCodeModelstring or null
buildingCodeLocalstring or null
residentialCodeModelstring or null
residentialCodeLocalstring or null
fireCodeModelstring or null
fireCodeLocalstring or null
electricalCodeModelstring or null
electricalCodeLocalstring or null
windCodeModelstring or null
windCodeLocalstring or null
codesOtherstring or null
firePathwaysEnforcedboolean or null
electricalEngineerStampRequiredboolean or null
structuralStampRequiredboolean or null
climateZonestring or null
ashraeMinTempCdouble or null
ashraeMaxTempCdouble or null
ashraeMinTempFdouble or null

Auto-computed from ashraeMinTempC. Used for NEC 690.7 max-Voc string sizing.

ashraeMaxTempFdouble or null

Auto-computed from ashraeMaxTempC. Used for thermal derating in PV performance modeling.

centroidLatitudedouble or null
centroidLongitudedouble or null
landAreaSqMilesdouble or null
specialZoneslist of strings or null
buildingDeptHourslist of strings or null
tigerYearinteger or null
funcstatstring or null
US Census functional status code.
createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"
custommap from strings to any

Custom field values keyed by property keyName. This includes only customer-defined custom columns (see GET /properties?record_type=ahj). Built-in catalog AHJ fields (turnaround, website, fees, notes, etc.) are exposed as top-level fields on the AHJ object and are read-only.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
502
Bad Gateway Error