Appoint a board member
Gives an owner a board seat, starting now. Requires the hoa_board_members:write permission.
Authorization
AuthorizationstringrequiredBody
application/json
ownerIdstringrequiredThe owner to seat on the board.
rolestringFree text describing the seat, for example President or Treasurer. There is no fixed list and nothing enforces one role per company.
Response
200 · The new board seat.
idstringThe board seat. A 64-bit id sent as a decimal string.
companyIdstringThe company the seat belongs to.
ownerIdstringThe owner who holds the seat.
activebooleantrue while the owner is serving. An inactive row is the record of a past seat.
rolestringFree text describing the seat, for example President. Absent when none was given.
seatStartedAtstring · date-timeWhen the seat began, in the company's timezone. Set to the moment of appointment.
seatEndedAtstring · date-timeWhen the seat ended, in the company's timezone. Absent while the member is still serving.
createdstring · date-timeWhen the row was created, in the company's timezone.
updatedstring · date-timeWhen the row last changed, in the company's timezone.
400 · `ownerId` is not a number, the owner already holds an active seat, or the calling company is not in HOA business mode.
401 · The bearer token is missing, expired, or not valid.
403 · The token is valid but the caller does not hold the `hoa_board_members:write` permission.
Appointing an owner who is already serving returns 400 Bad Request with the detail Hoa Member is already an active Hoa Board Member. To change someone's role, deactivate the seat and appoint them again — there is no endpoint that edits a seat in place.
Active board members are the electorate. When an architectural request is submitted, everyone active at that moment becomes an eligible voter on it, and publishing a survey aimed at the board does the same. Changing the roster afterwards does not change a vote that is already open.
Every architectural request and board member endpoint first checks that the calling company is set up as an HOA. A company in any other business mode gets 400 Bad Request with the detail Company is not in HOA business mode.