Request a file upload session for an owner contribution

Asks for a one-time upload slot for a file belonging to an owner contribution. Upload the file to the returned endpoint, then attach it with the add-files endpoint. Attachments may be images or PDFs of up to 20 MB.

POST

https://api.portal.magicdoor.com/company-app/owners/contributions/{ownerContributionId}/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

ownerContributionIdstringrequired

The owner contribution. A Snowflake id sent as a decimal string.

example: 1842110447398404096

Body

application/json

fileNamestringrequired

The name to store the file under. 1 to 250 characters.

fileSizeintegerrequired

The size of the file in bytes. Attachments are limited to 20 MB.

contentTypestringrequired

The file's media type. Must be an image type or application/pdf.

Response

200 · The upload slot. Post the file to `endpoint` with `method`, including every entry in `fields` as a form field, before the session expires.

sessionIdstring

The session. Pass it to the add-files endpoint as uploadSessionId once the file has been uploaded.

endpointstring

The URL to upload the file to.

methodstring

The HTTP method to upload with.

fieldsobject

Form fields that must accompany the upload, as a name-to-value map. Send them exactly as given.

expiresstring · date-time

When the slot stops accepting the upload, in the company's timezone.