POST v1/units/{id}/updateemailaddress

Updates only the email address of the primary resident

Request Information

URI Parameters

Name	Description	Type	Additional information
id	UnitID of the unit	integer	Required

Body Parameters

Object in request body containing the api key and email address

EmailUpdateVm

Name	Description	Type	Additional information
ApiKey		string	None.
EmailAddress		string	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "emailAddress": "sample string 2"
}

application/xml, text/xml

Sample:

<EmailUpdateVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GPIWebDashboard.API.Models">
  <ApiKey>sample string 1</ApiKey>
  <EmailAddress>sample string 2</EmailAddress>
</EmailUpdateVm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Updated unit record

UnitVm

Name	Type	Additional information
UnitId	integer	None.
AssociationId	integer	None.
UnitNumber	string	None.
BuildingNumber	string	None.
PropertyAddress_Street1	string	None.
PropertyAddress_Street2	string	None.
PropertyAddress_City	string	None.
PropertyAddress_State	string	None.
PropertyAddress_ZipCode	string	None.
MailingAddress_Street1	string	None.
MailingAddress_Street2	string	None.
MailingAddress_City	string	None.
MailingAddress_State	string	None.
MailingAddress_ZipCode	string	None.
MailingAddress_IsInternational	boolean	None.
MailingAddress_Country	string	None.
CreateDate	date	None.
ModifyDate	date	None.
FirstName	string	None.
LastName	string	None.
EmailAddress	string	None.
AlternateEmailAddress	string	None.
PhoneNumber	string	None.
CellNumber	string	None.
MailingAddress_AddressCoName	string	None.
AccountNumber	string	None.
MailingAddressName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "unitId": 1,
  "associationId": 2,
  "unitNumber": "sample string 3",
  "buildingNumber": "sample string 4",
  "propertyAddress_Street1": "sample string 5",
  "propertyAddress_Street2": "sample string 6",
  "propertyAddress_City": "sample string 7",
  "propertyAddress_State": "sample string 8",
  "propertyAddress_ZipCode": "sample string 9",
  "mailingAddress_Street1": "sample string 10",
  "mailingAddress_Street2": "sample string 11",
  "mailingAddress_City": "sample string 12",
  "mailingAddress_State": "sample string 13",
  "mailingAddress_ZipCode": "sample string 14",
  "mailingAddress_IsInternational": true,
  "mailingAddress_Country": "sample string 16",
  "createDate": "2025-12-05T22:20:41.2749325-05:00",
  "modifyDate": "2025-12-05T22:20:41.2749325-05:00",
  "firstName": "sample string 17",
  "lastName": "sample string 18",
  "emailAddress": "sample string 19",
  "alternateEmailAddress": "sample string 20",
  "phoneNumber": "sample string 21",
  "cellNumber": "sample string 22",
  "mailingAddress_AddressCoName": "sample string 23",
  "accountNumber": "000002-sample string 4-sample string 3",
  "mailingAddressName": "sample string 23"
}

application/xml, text/xml

Sample:

<UnitVm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GPIWebDashboard.API.Models">
  <AssociationId>2</AssociationId>
  <BuildingNumber>sample string 4</BuildingNumber>
  <CellNumber>sample string 22</CellNumber>
  <MailingAddress_AddressCoName>sample string 23</MailingAddress_AddressCoName>
  <MailingAddress_City>sample string 12</MailingAddress_City>
  <MailingAddress_Country>sample string 16</MailingAddress_Country>
  <MailingAddress_IsInternational>true</MailingAddress_IsInternational>
  <MailingAddress_State>sample string 13</MailingAddress_State>
  <MailingAddress_Street1>sample string 10</MailingAddress_Street1>
  <MailingAddress_Street2>sample string 11</MailingAddress_Street2>
  <MailingAddress_ZipCode>sample string 14</MailingAddress_ZipCode>
  <PropertyAddress_City>sample string 7</PropertyAddress_City>
  <PropertyAddress_State>sample string 8</PropertyAddress_State>
  <PropertyAddress_Street1>sample string 5</PropertyAddress_Street1>
  <PropertyAddress_Street2>sample string 6</PropertyAddress_Street2>
  <PropertyAddress_ZipCode>sample string 9</PropertyAddress_ZipCode>
  <UnitId>1</UnitId>
  <UnitNumber>sample string 3</UnitNumber>
</UnitVm>