Portfolios

Deactivate a portfolio

Marks a portfolio inactive. By default the call is refused while the portfolio still holds active properties; forceDeactivateChildren deactivates them along with it.

DELETE

https://api.portal.magicdoor.com/company-app/portfolios/{portfolioId}/deactivate

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.

Path parameters

portfolioIdstringrequired

Snowflake id of the portfolio, as a decimal string.

example: 1830472847398404096

Query parameters

forceDeactivateChildrenboolean

Leave it false and the call is refused with a 409 while any property in the portfolio is still active. Set it true to deactivate those properties as part of the same call.

default: false

Response

200 · The portfolio is now inactive. The response has no body.

401 · The access token is missing, expired, or not for this company.

404 · No portfolio with that id, or it belongs to another company.

409 · The portfolio still holds active properties and `forceDeactivateChildren` was not set. The problem document's `title` says how many are in the way.

It is a DELETE, but nothing is deleted

Deactivating flips the portfolio's active flag to false. The record, its properties and their history all stay. Use the delete endpoint when you really want the row gone.