Update Home Profile
put
/apis/customer-data-v2/{utilityCode}/customers/{id}/home_profile
Update the home profile for a customer.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Customer id to list utility accounts for.
-
utilityCode(required): string
A 3- or 4-character representation of the client code. Valid examples - "UTIL" and "util"
The json representation of a home profile to update
Root Schema : HomeProfile
Type:
Show Source
object
-
customerId:
integer
The internal customer idExample:
31
-
dwellingType:
string
Allowed Values:
[ "MULTI_FAMILY", "NON_RESIDENTIAL", "SINGLE_FAMILY" ]
The type of dwelling. Optional.Example:SINGLE_FAMILY
-
heatType:
string
Allowed Values:
[ "ELEC", "GAS", "NONE", "OTHER", "LPG", "OIL", "WOOD", "DISTRICT_HEATING", "GEOTHERMAL" ]
The type of heating that a dwelling usesExample:ELEC
-
numberOfAdults:
integer
The number of adults in this dwellingExample:
2
-
numberOfChildren:
integer
The number of children in this dwellingExample:
1
-
squareFeet:
integer
The square footage of this dwellingExample:
2100
Response
Supported Media Types
- application/json
204 Response
Successful operation. Home Profile for this customer updated.
400 Response
Invalid request
Root Schema : ErrorResponse
Type:
Show Source
object
-
details:
string
Details about the error.
-
errorMessage:
string
Short failure explanation.
-
httpStatus:
integer
Minimum Value:
100
Maximum Value:600
The HTTP status code for the error. -
serviceErrorCode:
string
An error code for the error.
401 Response
Authorization failure
Root Schema : ErrorResponse
Type:
Show Source
object
-
details:
string
Details about the error.
-
errorMessage:
string
Short failure explanation.
-
httpStatus:
integer
Minimum Value:
100
Maximum Value:600
The HTTP status code for the error. -
serviceErrorCode:
string
An error code for the error.
404 Response
Customer or site not found
Root Schema : ErrorResponse
Type:
Show Source
object
-
details:
string
Details about the error.
-
errorMessage:
string
Short failure explanation.
-
httpStatus:
integer
Minimum Value:
100
Maximum Value:600
The HTTP status code for the error. -
serviceErrorCode:
string
An error code for the error.
500 Response
Internal error
Root Schema : ErrorResponse
Type:
Show Source
object
-
details:
string
Details about the error.
-
errorMessage:
string
Short failure explanation.
-
httpStatus:
integer
Minimum Value:
100
Maximum Value:600
The HTTP status code for the error. -
serviceErrorCode:
string
An error code for the error.