PUT /api/v3/energyproject/{projectId}

Updates an existing energy project

EditEnergyProjectV3 Permissions: FacilityProjects (Edit)
Use this endpoint to modify an energy project’s properties including type, savings units, dates, and expected savings values. Requires Facility Projects Edit permission.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Path Parameters

Name Description Type Required
projectId Unique numeric identifier of the energy project to update integer (int32) Required

Request Body

EnergyProjectEdit
Property Description Type
costSavings The cost savings amount Required (defined) number (double)
costSavingsUnitCode The cost savings unit code Required (defined) string
energyProjectCode Short alphanumeric code uniquely identifying this project. Max 128 characters Required Must be between 0 and 128 characters string
energyProjectInfo The energy project info Required Must be between 0 and 128 characters string
energyProjectTypeCode The energy project type code Required string
energySavings The energy savings amount Required (defined) number (double)
energySavingsUnitCode The energy savings unit code Required (defined) string
expectedImpact The expected impact of the energy project (positive, negative, unknown) One of ‘positive’, ’negative’, ‘unknown’ Required (defined) string
fundingSource The funding source of the project Required (defined) string
installationBeginDate The energy project installation begin date Required (defined) string (date-time)
installationCost The energy project installation cost Required (defined) number (double)
installationEndDate The energy project installation end date Must be greater than InstallationBeginDate Required (defined) string (date-time)
note The miscellaneous note about the project Required (defined) string
placeId Unique numeric identifier of the place (building) where the project is installed Required (defined) integer (int32)
projectManager The project manager of the energy project Required (defined) string
utilityRebate The rebate amount of energy project Required (defined) number (double)
Example Request Body application/json 
{  "costSavings": 1.0,  "costSavingsUnitCode": "string",  "energyProjectCode": "string",  "energyProjectInfo": "string",  "energyProjectTypeCode": "string",  "energySavings": 1.0,  "energySavingsUnitCode": "string",  "expectedImpact": "string",  "fundingSource": "string",  "installationBeginDate": "2026-06-29",  "installationCost": 1.0,  "installationEndDate": "2026-06-29",  "note": "string",  "placeId": 1,  "projectManager": "string",  "utilityRebate": 1.0
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

EnergyProjectResponse
Property Description Type
costSavings CostSavingsChild
CostSavingsChild properties
Property Description Type
costSavings Projected or measured cost savings amount. Null if not set number (double)
costSavingsUnit CostSavingsUnit
CostSavingsUnit properties
Property Description Type
costSavingsUnitCode Short code for the currency unit (e.g., “USD”) string
costSavingsUnitId Unique numeric identifier of the cost savings unit integer (int32)
costSavingsUnitInfo Descriptive name of the currency unit (e.g., “US Dollars”) string
energyProjectCode Short alphanumeric code uniquely identifying this project (e.g., “LED-RETRO-2024”) string
energyProjectId Unique numeric identifier of the energy project integer (int32)
energyProjectInfo Descriptive name or title of the energy project string
energyProjectType EnergyProjectType
EnergyProjectType properties
Property Description Type
energyProjectTypeCode Short alphanumeric code identifying this project type (e.g., “LIGHT”) string
energyProjectTypeId Unique numeric identifier of the project type integer (int32)
energyProjectTypeInfo Descriptive name of the project type (e.g., “Lighting Retrofit”) string
energySavings EnergySavingsChild
EnergySavingsChild properties
Property Description Type
energySavings Projected or measured energy savings amount. Null if not set number (double)
energySavingsUnit EnergySavingsUnit
EnergySavingsUnit properties
Property Description Type
energySavingsUnitCode Short code for the unit (e.g., “KWH”, “THERM”) string
energySavingsUnitId Unique numeric identifier of the energy savings unit integer (int32)
energySavingsUnitInfo Descriptive name of the unit (e.g., “Kilowatt Hours”) string
expectedImpact Expected energy impact classification: “positive” (saves energy), “negative” (increases energy), or “unknown” string
fundingSource Description of the funding source for this project (e.g., “Capital Budget”, “Grant”) string
installationBeginDate Date when project installation began. Format: date-only. Null if not set string (date-time)
installationCost Total cost of the project installation in the organization’s base currency. Null if not set number (double)
installationEndDate Date when project installation was completed. Format: date-only. Null if not set string (date-time)
note Free-text note with additional project details string
place EnergyProjectPlaceChild
EnergyProjectPlaceChild properties
Property Description Type
isDataRolledUp When true, this place’s utility data rolls up to parent places in the hierarchy. When false, data is excluded from parent aggregations boolean
placeCode Short alphanumeric code identifying this place string
placeId Unique numeric identifier of the place integer (int32)
placeInfo Descriptive name of the place string
projectManager Name of the person managing this project string
utilityRebate Dollar amount of utility rebate received for this project. Null if no rebate number (double)
Example Response application/json 
{  "costSavings": {    "costSavings": 1.0,    "costSavingsUnit": {      "costSavingsUnitCode": "string",      "costSavingsUnitId": 1,      "costSavingsUnitInfo": "string"
    }
  },  "energyProjectCode": "string",  "energyProjectId": 1,  "energyProjectInfo": "string",  "energyProjectType": {    "energyProjectTypeCode": "string",    "energyProjectTypeId": 1,    "energyProjectTypeInfo": "string"
  },  "energySavings": {    "energySavings": 1.0,    "energySavingsUnit": {      "energySavingsUnitCode": "string",      "energySavingsUnitId": 1,      "energySavingsUnitInfo": "string"
    }
  },  "expectedImpact": "string",  "fundingSource": "string",  "installationBeginDate": "2026-06-29",  "installationCost": 1.0,  "installationEndDate": "2026-06-29",  "note": "string",  "place": {    "isDataRolledUp": false,    "placeCode": "string",    "placeId": 1,    "placeInfo": "string"
  },  "projectManager": "string",  "utilityRebate": 1.0
}
404 Not Found The requested resource was not found. Verify the ID or path is correct.