MagicDoorAPI
SupportOpen MagicDoor
Work orders

Message a work order's vendor

Sends the vendor a message about the work order — as a chat message, as an email, or both. Send whichever bodies you want; leaving one out simply means that channel is not used. Requires the work_orders:write permission.

POST
https://services.magicdoor.com/maintenance/company-portal/work-orders/{workOrderId}/notification/vendor

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

workOrderIdstringrequired

The work order to act on. A Snowflake id, sent as a decimal string.

example: 1841200938471029248

Body

application/json

Attachments are named by upload session id from Start a file upload for a vendor message — this endpoint does not carry file content itself.

chatMessagestring

The text to post into the vendor chat. Leave it out to send nothing by chat. Whitespace-only text counts as nothing.

emailMessagestring

The body of the email. Leave it out to send no email.

subjectstring

The email's subject line.

chatAttachmentSessionIdsstring[]

Upload sessions to attach to the chat message.

emailAttachmentSessionIdsstring[]

Upload sessions to attach to the email.

Response

200 · The message was sent. The response has no body.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `work_orders:write` permission.

404 · No such work order, or it belongs to another company.

422 · The work order has no vendor assigned, the assigned vendor no longer exists, the vendor has been deactivated, or a chat message was asked for and no vendor chat could be opened.