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

ahj_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
idintegerOptional
Unique identifier.
uuidstring or nullOptional

AHJID UUID (when known).

namestringOptional

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

typeenum or nullOptional
Jurisdiction type.
countrystringOptional

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

statestring or nullOptional

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

stateNamestring or nullOptional

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

parentCountystring or nullOptional

For sub-county jurisdictions, the containing county name.

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

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

isActivebooleanOptional
Whether this AHJ is currently active in the catalog.
isPrivateboolean or nullOptional

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

pointOfContactstring or nullOptional
submissionMethodstring or nullOptional

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

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

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

ashraeMaxTempFdouble or nullOptional

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

centroidLatitudedouble or nullOptional
centroidLongitudedouble or nullOptional
landAreaSqMilesdouble or nullOptional
specialZoneslist of strings or nullOptional
buildingDeptHourslist of strings or nullOptional
tigerYearinteger or nullOptional
funcstatstring or nullOptional
US Census functional status code.
createdAtstringOptionalformat: "date-time"
updatedAtstringOptionalformat: "date-time"
custommap from strings to anyOptional

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