utilities

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.

patch/utilities/{utility_id}

Request

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

Path parameters

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

Response

Utility updated successfully

idinteger

Unique identifier.

namestring

Utility name.

statestring nullable

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

stateNamestring nullable

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

ownershipType'INVESTOR' | 'MUNICIPAL' | 'MUNICIPAL_MARKETING_AUTHORITY' | 'COOPERATIVE' | 'FEDERAL' | 'STATE' | 'POLITICAL' | 'COMMUNITY_CHOICE_AGGREGATOR' | 'WHOLESALE_POWER_MARKETER' | 'OTHER'
holdingCompanystring nullable
addressstring nullable
phonestring nullable
websitestring nullable
hoursOfOperationstring nullable
isActiveboolean

Whether this utility is currently active in the catalog.

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

Changes

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