Add a note to a chat

Writes an internal note on a chat, visible to your team only. The tenant, owner, or vendor never sees it and nothing is sent.

POST

https://api.portal.magicdoor.com/company-app/chats/{chatId}/notes

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

chatIdstringrequired

The chat to annotate.

example: 1830472847398404096

Body

application/json

bodystringrequired

The note text.

example: Tenant prefers afternoons. Do not call before 1pm.

metadataobject

Free-form key/value data to store alongside the note.

Response

200 · The note.

idstring

The note.

chatIdstring

The chat the note is attached to.

kindenum<string>

note is text somebody wrote; action is a record of something that happened in the chat.

noteaction

audienceenum<string>

Who the note is for. Only propertyManager notes are returned here.

propertyManageraiOnly

authorenum<string>

Who wrote the note.

propertyManageraisystem

authorPropertyManagerIdstring

The property manager who wrote it. Absent on AI and system notes.

bodystring

The note text.

referencedEntityTypeenum<string>

The kind of record this note points at, when it points at one.

referencedEntityIdstring

The record this note points at.

editedByPropertyManagerIdstring

The property manager who last edited it. Absent if never edited.

editedAtstring · date-time

When it was last edited.

createdAtstring · date-time

When it was written.

updatedAtstring · date-time

When the row last changed.

metadataobject

Free-form key/value data stored with the note.

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

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

The note is recorded against the property manager whose token you are using, and appears in the chat's timeline alongside the messages.