announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Web Service Documentation / Categories / Basic Account Services / Edit Customer

Edit Customer

Updated on August 25, 2019

Description

Updates an account for your customer that you are already connected to. The following fields can only be updated:
  • includeTestPropertiesInGraphics
  • billboardMetric
  • emailPreferenceCanadianAccount
  • languagePreference
If the optional "billboardMetric" element is included, this setting will clear any previously set property level billboard metric settings for all properties within the specified customer's account.

Version

25.0

HTTP Method

PUT

Resource URL

/customer/(customerId)

Header

Field Name Value Comments
Authorization Basic credentials
Content-Type application/xml

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request customer.xsd
Response response.xsd

Example Requests

The following example updates a customer account that has an id of 23421.

PUT  /customer/23421

<?xml version="1.0" encoding="UTF-8"?>
<customer>
     <includeTestPropertiesInGraphics>false</includeTestPropertiesInGraphics>
     <billboardMetric>score</billboardMetric>
</customer>

The following example updates a customer account that has an id of 23421. If the customer account belongs to Canada, an email preference setting (emailPreferenceCanadianAccount) can also be included which indicates whether the account can receive ENERGY STAR information from the Natural Resources of Canada (NRCAN).

PUT  /customer/23421

<?xml version="1.0" encoding="UTF-8"?>
<customer>
     <includeTestPropertiesInGraphics>false</includeTestPropertiesInGraphics>
     <billboardMetric>score</billboardMetric>
     <emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount>
</customer>

Example Response

The following example indicates that the customer account was successfully updated.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>23421</id>
     <links>
          <link httpMethod="GET" link="/customer/23421" linkDescription="This is the GET url for this Customer."/>
     </links>
</response>
TEST