MagicDoorAPI
SupportOpen MagicDoor
Maintenance requests

Start a file upload for a maintenance request

Asks for a one-time upload slot for a photo, video or PDF you want to attach to a maintenance request. This endpoint does not take the file — it hands back where to PUT or POST the bytes, and a session id you then pass to Attach files to a maintenance request. Requires the maintenance_requests:write permission.

POST
https://services.magicdoor.com/maintenance/company-portal/maintenance-requests/{maintenanceRequestId}/files/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

maintenanceRequestIdstringrequired

The maintenance request to act on. A Snowflake id, sent as a decimal string.

example: 1841003948572119040

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 maintenance request file.

contentTypestringrequired

The file's MIME type. Maintenance request files accept any image/* or video/* type, and application/pdf. 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 `maintenance_requests:write` permission.

404 · No such maintenance request, or it belongs to another company.

The three steps

  1. Ask for a slot

    Call this endpoint with the file's name, size and type. You get back sessionId and an endpoint.

  2. Send the bytes

    Send the file to endpoint using the method you were given, including every name and value in fields. This goes to the storage provider directly, not to the MagicDoor API.

  3. Attach it

    Call Attach files to a maintenance request with the sessionId. Until you do, the file is not on the request.