Cancel an architectural request
Cancels an architectural request that has not been decided yet and closes any open board vote. Requires the hoa_architectural_requests:write permission.
Authorization
AuthorizationstringrequiredPath parameters
boardRequestIdstringrequiredThe architectural request to act on.
Response
200 · The request, now `cancelled`.
idstringThe architectural request. A 64-bit id sent as a decimal string.
companyIdstringThe company the request belongs to.
portfolioIdstringThe portfolio the request was filed under. Absent when it was created without one.
propertyIdstringThe property the requested work is on.
propertyNamestringNever returned by this endpoint — only the list and the single-request read resolve property names.
unitIdstringThe unit the requested work is on. Absent when the request covers the whole property.
unitNamestringNever returned by this endpoint — only the list and the single-request read resolve unit names.
submittedByOwnerIdstringThe owner the request was filed on behalf of.
submittedByOwnerNamestringNever returned by this endpoint — only the single-request read resolves owner names.
titlestringShort summary of the work being requested.
descriptionstringFull description of the work being requested.
statusenum<string>Where the request has reached in the review workflow.
dueAtstring · date-timeDeadline for the board to finish voting, in the company's timezone. Defaults to 30 days after creation, and is absent once it has been cleared.
isOverduebooleantrue once the deadline passed while the request was still in boardVoting and a background sweep moved it to readyForPmReview. It is never set back to false.
voteSessionIdstringThe board vote opened for this request. Absent until the request has been submitted for voting.
boardRequestProgressobjectNever returned by this endpoint — only the single-request read computes voting tallies.
pmDecisionenum<string>The manager's final decision. Absent until the request is approved or denied.
pmDecidedAtstring · date-timeWhen that decision was recorded, in the company's timezone. Absent until it is made.
pmNotestringThe note the manager left with the decision. Absent when none was sent.
filesobject[]Files attached to the request. Empty when there are none.
createdstring · date-timeWhen the request was created, in the company's timezone.
updatedstring · date-timeWhen the request last changed, in the company's timezone.
400 · The request is already `approved`, `denied`, or `cancelled`, 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_architectural_requests:write` permission.
404 · No request with that id belongs to the calling company.
A request that has already been approved, denied, or cancelled returns 400 Bad Request with the detail Board request cannot be cancelled in its current status. Cancelling is final — there is no endpoint that reopens a cancelled request.
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.