Settings

Remove a stored setting

Deletes the row stored at one level for one settings type, so that entity falls back to whatever its parent level says. Point it at company and the company drops back to MagicDoor's built-in default. Requires the settings:delete permission.

DELETE
https://services.magicdoor.com/settings/company-portal/settings/{settingsType}/{level}/{levelId}

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

settingsTypeenum<string>required

Which family of settings to act on. Matched case-insensitively against the registered settings types.

example: propertyachpaymentprocessingagentschatassociationviolationautopayincentiveschatchataichataileasechataileaserenewalchataileaserentersinsurancechataimaintenancerequestschataitranslationcommunicationscompanycontributiondepositpaymentdistributionemailemailnotificationlatefeesleasechartofaccountleaseinvoiceleaserenewalleaserentersinsurancemaintenancerequestmaintenancerequestrunbookmanagementfeeoutgoingpaymentspropertyrentalapplicationrentalapplicationbillingrentalapplicationchartofaccountrentalapplicationgeneralrentalapplicationpaymentrentalapplicationpaymentaccountrentalapplicationquestionnairerentalapplicationscreeningrentpaymentrentpaymentfailurefeerentpaymentnotificationrentpaymentprocessingfeessyndicationtenantautopayfailednotificationtenantpaymentremindertextworkorder
levelenum<string>required

The kind of entity the setting is attached to. Matched case-insensitively.

example: propertycompanyportfoliopropertyunitlease
levelIdstringrequired

The entity whose stored row should be removed, of the kind named by level. A Snowflake id, sent as a whole number in the URL.

example: 1842918365109710848

Response

200 · The row was removed, or there was nothing stored to remove. The response has no body.

401 · The access token is missing, expired, or invalid.

403 · The caller does not hold the `settings:delete` permission.

404 · No settings type is registered under the `settingsType` in the URL.

Deleting a row that was never stored is not an error — the call succeeds and nothing changes. If the row belongs to a group, only this one row is removed and the rest of the group stays.