MagicDoorAPI
SupportOpen MagicDoor
Lease renewals

Apply a renewal offer

Applies an existing offer to the lease: moves the end date, changes the recurring charges the offer names, and adds any new ones. The offer becomes finalized.

POST
https://api.portal.magicdoor.com/company-app/leases/{leaseId}/renewals/{offerId}/apply

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

leaseIdstringrequired

The lease the offer is on. A Snowflake id, sent as a decimal string.

example: 1830472847398404096
offerIdstringrequired

The offer to apply. A Snowflake id, sent as a decimal string.

example: 1841029384756201984

Response

200 · The offer, now applied.

idstring

Id of the renewal offer. A Snowflake id, sent as a decimal string.

statusenum<string>

Where the offer stands: offered while the tenant has not answered, signing once the document has gone out for signature, finalized once it has been applied to the lease, rejected if the tenant turned it down, retracted if it was pulled.

offeredsigningfinalizedrejectedretracted
requiresSigningboolean

Whether the tenant has to sign a document before the offer can be applied.

recurringChargeChangesRecurringChargeChange[]

Changes to the lease's existing recurring charges. One entry per charge you are changing.

newRecurringChargesNewRecurringCharge[]

Recurring charges to add when the renewal is applied.

newEndDatestring · date

The end date the lease would get. Absent means the renewal makes the lease month to month.

customLeaseTextstring

Extra wording to put on the renewal document. Up to 500 characters.

leaseDocumentIdstring

The renewal document created for signing. A Snowflake id, sent as a decimal string.

finalizedboolean

Whether the offer has been applied to the lease.

offerExpiresstring · date

The date the offer stops being open to the tenant.

currentChargesRecurringLeaseCharge[]

The lease's recurring charges as they stand today, so the offer can be shown against them.

templatesTemplateRef[]

Templates to build the renewal document from.

chartOfAccountsChartOfAccount[]

Chart-of-account records referenced above.

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

404 · No renewal offer on this lease matched the id, or it belongs to another company.