API ReferenceUtilities

Update Utility

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

Built-in utility fields (name, state, ownershipType, holdingCompany, etc.) 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

utility_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=utility.

Response

Utility updated successfully
idintegerOptional
Unique identifier.
namestringOptional
Utility name.
statestring or nullOptional

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

stateNamestring or nullOptional

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

ownershipTypeenum or nullOptional
holdingCompanystring or nullOptional
addressstring or nullOptional
phonestring or nullOptional
websitestring or nullOptional
hoursOfOperationstring or nullOptional
isActivebooleanOptional
Whether this utility is currently active in the catalog.
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=utility). Built-in catalog utility fields (name, state, ownershipType, holdingCompany, etc.) are exposed as top-level fields on the utility object and are read-only.

Errors

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