Automatic renewals

Create an automatic renewal setting

Adds a standing rule for raising renewal offers automatically. Name a propertyId or a portfolioId to scope the rule, or leave both out for a company-wide one. This does not create any offer by itself.

POST

https://api.portal.magicdoor.com/company-app/leases/renewals/automatic

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.

Body

application/json

portfolioIdstring

Scope the rule to this portfolio. A Snowflake id, sent as a decimal string.

propertyIdstring

Scope the rule to this property. A Snowflake id, sent as a decimal string.

addDaysBeforeinteger

How many days before a lease's end date to raise the offer. Between 1 and 365.

rentIncreasenumber

Rent increase to apply, as a fraction between 0 and 1 — 0.05 means five per cent.

newLeaseLengthMonthsinteger

How many months the renewed term should run for. Between 1 and 60.

newRecurringChargesobject[]

Recurring charges the renewal should add.

conditionsobject[]

Condition groups a lease must satisfy before an offer is raised. Each group needs an operator of and or or and at least one condition.

sendTenantNotifyOnRenewalboolean

Whether to tell the tenant when an offer is raised.

templatesobject[]

Templates the renewal document should be built from.

Response

200 · The settings record that was created.

idstring

Id of the settings record. A Snowflake id, sent as a decimal string.

companyIdstring

The company the settings belong to. A Snowflake id, sent as a decimal string.

portfolioIdstring

The portfolio these settings apply to. Absent on company-wide settings. A Snowflake id, sent as a decimal string.

propertyIdstring

The property these settings apply to. Absent on portfolio-wide or company-wide settings. A Snowflake id, sent as a decimal string.

creatorobject

Who created the record.

addDaysBeforeinteger

How many days before a lease's end date the offer is raised.

rentIncreasenumber

The rent increase to apply, as a fraction between 0 and 1 — 0.05 means five per cent.

newLeaseLengthMonthsinteger

How many months the renewed term runs for.

newRecurringChargesNewRecurringCharge[]

Recurring charges to add when the renewal is applied.

conditionsConditionGroup[]

Groups of conditions a lease must meet before an offer is raised. Each group joins its own conditions with and or or, and every condition names its type.

sendTenantNotifyOnRenewalboolean

Whether the tenant is told when an offer is raised.

templatesTemplateRef[]

Templates the renewal document is built from.

createdstring · date-time

When the settings were created, in the company's timezone.

updatedstring · date-time

When they last changed.

400 · The request failed validation. `errors` maps each field name to what was wrong with it.

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

This is the standing policy, not an offer

These settings tell MagicDoor when and how to raise renewal offers by itself. They are not offers. To work with a specific renewal on a specific lease, see Lease renewals.