File attachments

Delete an attachment

Removes an attachment from its record.

DELETE

https://api.portal.magicdoor.com/company-app/file-attachments/{entityType}/{entityId}/{fileAttachmentId}

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

entityTypeenum<string>required

What kind of record the file hangs off. Written in the path in lower case, for example lease.

example: leaseleaseunitpropertyportfoliocompanytenantvendormaintenanceRequestworkOrderbilltransactionchatchatMessagepropertyManagerunknownrentalApplicationleaseTemplateleaseDocumentassociationViolationownerunitListingfileworkOrderGroup

entityIdstringrequired

The record the file hangs off, of the kind named by entityType. A Snowflake id sent as a decimal string.

example: 1830472847398404096

fileAttachmentIdstringrequired

The attachment to act on. A Snowflake id sent as a decimal string.

example: 1830472847398420020

Delete an attachment

Authorization

Path parameters

Response

200 · The attachment was deleted. No body is returned.

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

404 · No file attachment with that id exists in the caller's company.