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

Edit Account

Updated on June 24, 2019

Description

This web service updates your account based on the information provided in the XML request. It returns the unique identifier to the updated account and a link to the corresponding web service to retrieve it. If the optional "billboardMetric" element is included, this setting will clear any previously set property level billboard metric settings for all properties within the authenticated user's account.

Version

23.0

HTTP Method

PUT

Resource URL

/account

Header

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

Authorization Required

Yes

Parameters

None

XML Schemas

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

Example Requests

The following example updates your account information.

PUT  /account

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_dx_user</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <address address1="123 Main St" city="Arlington" state="VA" postalCode="22201" country="US"/>
          <email>john_doe@acme.com</email>
          <jobTitle>Building Administrator Data Exchange User</jobTitle>
          <phone>703-555-2121</phone>
     </contact>
     <organization name="ACME Corporation">
          <primaryBusiness>Other</primaryBusiness>
          <otherBusinessDescription>other</otherBusinessDescription>
          <energyStarPartner>true</energyStarPartner>
          <energyStarPartnerType>Service and Product Providers</energyStarPartnerType>
     </organization>
     <includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
</account>

The following example updates your account information. If the 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  /account

<?xml version="1.0" encoding="UTF-8"?>
<account>
     <username>acme_dx_user</username>
     <password>PA$sw0r6</password>
     <webserviceUser>true</webserviceUser>
     <searchable>true</searchable>
     <billboardMetric>score</billboardMetric>
     <contact>
          <firstName>John</firstName>
          <lastName>Doe</lastName>
          <address address1="123 Main St" city="Edmonton" state="AB" postalCode="T5G 2S7" country="CA"/>
          <email>john_doe@acme.com</email>
          <jobTitle>Building Administrator Data Exchange User</jobTitle>
          <phone>703-555-2121</phone>
     </contact>
     <organization name="ACME Corporation">
          <primaryBusiness>Other</primaryBusiness>
          <otherBusinessDescription>other</otherBusinessDescription>
          <energyStarPartner>true</energyStarPartner>
          <energyStarPartnerType>Service and Product Providers</energyStarPartnerType>
     </organization>
     <includeTestPropertiesInGraphics>true</includeTestPropertiesInGraphics>
     <emailPreferenceCanadianAccount>true</emailPreferenceCanadianAccount>
</account>

Example Response

The following example indicates your account was successfully updated. It also returns the unique identifier to your account and a link to the corresponding web service to retrieve it.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
     <id>68001</id>
     <links>
          <link httpMethod="GET" link="/account" linkDescription="This is the GET url for this Account."/>
     </links>
</response>
LIVE