Letter document templates

Delete a letter document template

Removes a Word-document letter template and returns it one last time. Requires the letter_templates:delete permission.

DELETE
https://services.magicdoor.com/communications/company-portal/letter-templates/documents/{letterDocumentTemplateId}

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

letterDocumentTemplateIdstringrequired

The letter document template to delete. A 64-bit number sent as a string.

example: 1830538211944759296

Response

200 · The template as it was at the moment it was deleted. `filePublicUrl` is not part of this response.

idstringrequired

The letter document template. A 64-bit number sent as a string.

letterTemplateGroupIdstring

The group this template is filed under. Absent while it is ungrouped.

namestring

The name shown to the property manager. Absent when the template was created without one.

communicationChannelsenum<string>[]required

The kinds of recipient this template can be addressed to.

tenantownervendorleasemaintenanceRequestworkOrderrentalApplicationpropertyManagercompany
documentIdstringrequired

The document that holds the Word file behind this template. Pass it to nothing else in this reference — it is the handle the editor uses.

createdstring · date-timerequired

When the template was created, in the company's timezone and with no offset.

updatedstring · date-timerequired

When the template row was last changed, in the company's timezone and with no offset.

401 · The access token is missing, expired, or not a property-manager token.

403 · The token is valid but the caller does not hold the `letter_templates:delete` permission.

404 · No template with that id belongs to the caller's company, or it has already been deleted.