MagicDoorAPI
SupportOpen MagicDoor
Letter document templates

List document placeholder keys

Returns the placeholders a Word-document template may use for a given kind of recipient. Same source as the letter-template placeholder list, returned as a bare array and with the helper flag included.

GET
https://services.magicdoor.com/communications/company-portal/letter-templates/documents/keys

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.

Query parameters

channelsenum<string>[]required

The kinds of recipient the document is written for. Repeat the parameter for more than one value; you then get only the placeholders all of them share. Leave it out and you get an empty array.

example: leasetenantownervendorleasemaintenanceRequestworkOrderrentalApplicationpropertyManagercompany

Response

200 · The placeholders, as a bare array rather than a wrapped list.

keystringrequired

What you write inside the braces — key becomes {{key}} in the document.

displayNamestringrequired

A short label for a placeholder picker.

descriptionstringrequired

What the placeholder resolves to at send time.

isHelperbooleanrequired

true for a placeholder computed from the moment of sending rather than read off a record — send_date, next_rent_due_date and current_rent_period. Those three also take an optional date format string, as in {{send_date "d MMMM yyyy"}}.

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

The full set of keys, channel by channel, is on List placeholders. The two endpoints read the same registry; they differ only in shape — this one returns the array directly and adds isHelper, that one wraps the array in an items field and leaves isHelper out.