Set a company setting

Writes the company-level value for one settings type, creating it or replacing it outright. Overrides already stored on portfolios, properties, units and leases are left alone and continue to win over this value. Requires the settings:write permission.

POST

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

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

Body

application/json

settingsobjectrequired

The complete settings object for the chosen settingsType. Every property of that type must be supplied — this is a whole-object replacement, not a patch, and anything left out falls back to the type's built-in default. Snowflake ids inside the object are sent as decimal strings.

Response

200 · The stored company-level row.

…settings propertiesobject

The properties of the chosen settings type, spread across the top level of the response. The example below is the property settings type.

levelenum<string>

The kind of entity this stored row is attached to.

companyportfoliopropertyunitlease

levelIdstring

The id of the entity this stored row is attached to. At company level this is the company's own id.

groupIdstring

Identifies rows written together by a single multi-target override call. Absent on rows written on their own.

400 · The body could not be read as the chosen settings type, or a settings type with its own validator rejected the values.

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

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

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

The body replaces the stored value in full. Send every property of the settings type, not just the ones you are changing — omitted properties fall back to the type's built-in default rather than keeping their current value.