Board members

Appoint a board member

Gives an owner a board seat, starting now. Requires the hoa_board_members:write permission.

POST
https://services.magicdoor.com/hoa/company-portal/associations/board-members

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

ownerIdstringrequired

The owner to seat on the board.

example: 1830472847398405120
rolestring

Free 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.

idstring

The board seat. A 64-bit id sent as a decimal string.

companyIdstring

The company the seat belongs to.

ownerIdstring

The owner who holds the seat.

activeboolean

true while the owner is serving. An inactive row is the record of a past seat.

rolestring

Free text describing the seat, for example President. Absent when none was given.

seatStartedAtstring · date-time

When the seat began, in the company's timezone. Set to the moment of appointment.

seatEndedAtstring · date-time

When the seat ended, in the company's timezone. Absent while the member is still serving.

createdstring · date-time

When the row was created, in the company's timezone.

updatedstring · date-time

When 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.

One active seat per owner

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.

HOA companies only

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.