MagicDoorAPI
SupportOpen MagicDoor
Work orders

Start a file upload for a vendor message

Asks for a one-time upload slot for a file you want to send to the vendor as an attachment. This endpoint does not take the file — it hands back where to send the bytes, and a session id you then pass to Message a work order's vendor. Requires the work_orders:write permission.

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

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

fileNamestringrequired

The file's name, kept as the stored name. Between 1 and 250 characters.

fileSizeintegerrequired

Size of the file in bytes. At least 1, and at most 20971520 (20 MB) for a vendor message attachment.

contentTypestringrequired

The file's MIME type. Vendor message attachments accept image/*, video/*, audio/*, text/*, PDFs, Word and Office documents, JSON, XML, and zip or 7z archives. Between 1 and 200 characters.

Response

200 · Where to send the bytes.

sessionIdstringrequired

The upload session. Pass this as uploadSessionId once the bytes are up.

endpointstringrequired

The URL to send the file to. It is pre-signed and belongs to the storage provider, not to this API.

methodstringrequired

The HTTP method to use against endpoint, for example PUT or POST.

fieldsobjectrequired

Extra form fields the storage provider needs, as name-to-value pairs. Send them with the file when method is POST; the object is empty when none are needed.

expiresstring · date-timerequired

When the slot stops accepting the file, in the company's timezone and without an offset.

400 · The file name, size or content type is missing or outside the allowed range.

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.