Notes

Update a note

Replaces the text of an internal note. Its kind and the record it hangs off cannot be changed.

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

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
noteIdstringrequired

The note itself.

example: 1831077331442663424

Body

application/json

contentstringrequired

The replacement text.

example: Plumber rescheduled to Friday morning.

Response

200 · The updated note.

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.

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

404 · No note with that id belongs to your company.

The note is looked up by noteId alone; entityType and entityId in the URL are not checked against it.