Delete a resident benefit package

Removes a package for good and cancels every live enrollment on it. Requires the resident_benefit_packages:write permission.

DELETE

https://services.magicdoor.com/productexperiences/company-portal/resident-benefit-packages/packages/{packageId}

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

packageIdstringrequired

The package to delete, as a Snowflake id in decimal string form.

example: 1841776203441090560

Response

200 · The package was deleted.

liveEnrollmentCountintegerrequired

How many live enrollments were cancelled as part of the deletion.

401 · The request carried no valid access token.

403 · The caller is not a property manager, or is missing the `resident_benefit_packages:write` permission.

404 · No package with that id on this company, or it is already deleted.

This cannot be undone

Live enrollments are cancelled first — a tenant who has already been charged keeps their benefits until the end of the period they paid for, and one who has not is cancelled immediately. The package then disappears from every response.

If the intention is only to stop new enrollments while keeping the existing ones, set the package's enabled to false through Update the resident benefit settings instead.