Letter templates

Get a letter template

Fetch one letter template, with its email and chat content exactly as written.

GET
https://services.magicdoor.com/communications/company-portal/letter-templates/{id}

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

idstringrequired

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

example: 1830472847398404096

Response

200 · The letter template.

idstringrequired

The letter template. A 64-bit number sent as a string — do not parse it as a JavaScript number.

letterTemplateGroupIdstring

The group this template is filed under. Absent while the template 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
emailSubjectstring

Subject line used when the template is sent as an email. Absent when the template is chat-only.

emailBodystring

The email body, as HTML, with placeholders still in {{key}} form. Absent when the template is chat-only.

chatContentstring

The chat message body, as plain text, with placeholders still in {{key}} form. Absent when the template is email-only.

sourceFileIdstring

The uploaded Word file this template was imported from. Present only on imported templates, and it is what isImported filters on.

createdstring · date-timerequired

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

updatedstring · date-timerequired

When the template 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.

404 · No template with that id belongs to the caller's company.