ahJs

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.

patch/ahjs/{ahj_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/ahjs/{ahj_id}
  • Auth: API key in header x-api-key

Path parameters

ahj_idstring required

Query parameters

allow_new_optionsboolean

Whether to allow creation of new dropdown options during record creation

Request body

customobject required

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 nullable

AHJID UUID (when known).

namestring

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

type'STATE' | 'COUNTY' | 'CITY' | 'MUNICIPALITY' | 'TOWNSHIP' | 'TRIBAL'

Jurisdiction type.

countrystring

Two-letter country code (e.g. "US").

statestring nullable

Two-letter state code (e.g. "CA").

stateNamestring nullable

Full state name (e.g. "California").

parentCountystring nullable

For sub-county jurisdictions, the containing county name.

geoIdstring nullable

US Census TIGER GEOID for the boundary.

ahjRegistryCodestring nullable

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

isActiveboolean

Whether this AHJ is currently active in the catalog.

isPrivateboolean nullable

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

pointOfContactstring nullable
submissionMethodstring nullable

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

emailsstring[]
phonesstring[]
addressstring nullable
websitestring nullable
portalstring nullable

Permit portal URL.

turnaroundinteger nullable

Typical permit turnaround in days.

feesstring nullable
notesstring nullable
permitSubmissionNotesstring nullable
buildingCodeModelstring nullable
buildingCodeLocalstring nullable
residentialCodeModelstring nullable
residentialCodeLocalstring nullable
fireCodeModelstring nullable
fireCodeLocalstring nullable
electricalCodeModelstring nullable
electricalCodeLocalstring nullable
windCodeModelstring nullable
windCodeLocalstring nullable
codesOtherstring nullable
firePathwaysEnforcedboolean nullable
electricalEngineerStampRequiredboolean nullable
structuralStampRequiredboolean nullable
climateZonestring nullable
ashraeMinTempCnumber double nullable
ashraeMaxTempCnumber double nullable
ashraeMinTempFnumber double nullable

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

ashraeMaxTempFnumber double nullable

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

centroidLatitudenumber double nullable
centroidLongitudenumber double nullable
landAreaSqMilesnumber double nullable
specialZonesstring[] nullable
buildingDeptHoursstring[] nullable
tigerYearinteger nullable
funcstatstring nullable

US Census functional status code.

createdAtstring date-time
updatedAtstring date-time
customobject

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.

Changes

No recorded changes to this operation across all 1 revision of this API.