MagicDoorAPI
SupportOpen MagicDoor
Notes

Add a note to a record

Writes an internal note on a lease, tenant, property, or other record. Nothing is sent to anyone.

POST
https://api.portal.magicdoor.com/company-app/notes/{entityType}/{entityId}

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

entityTypeenum<string>required

What kind of record the notes are attached to. Matched without regard to case, so lease and Lease both work.

example: leaseleaseunitpropertyportfoliocompanytenantvendorownerpropertyManagermaintenanceRequestworkOrderbilltransactionrentalApplication
entityIdstringrequired

The record the notes are attached to — a lease id when entityType is lease, a tenant id when it is tenant, and so on.

example: 1829833104612495360

Body

application/json

contentstringrequired

The note text.

example: Tenant called about the leak; plumber booked for Thursday.
typeenum<string>required

note for a plain note, delinquency for one about non-payment. delinquency is only accepted when entityType is lease.

example: notenotedelinquency

Response

200 · The note that was written.

idstring

The note.

contentstring

The note text.

typeenum<string>

note is a plain note; delinquency marks a note about non-payment and is only allowed on a lease.

notedelinquency
createdAtstring · date-time

When the note was written.

propertyManagerobject

Who wrote it.

400 · `entityType` is not one a note can be attached to, or a `delinquency` note was sent for something other than a lease.

401 · The access token is missing, expired, or not valid.

Notes are internal to your team. Nothing here is shown to a tenant, owner, or vendor, and no message is sent.

The note is recorded against the property manager whose token you are using.