MagicDoorAPI
SupportOpen MagicDoor
Tenant portal invite templates

List invite templates

Returns the company's tenant portal invite templates, seeding MagicDoor's built-in ones on first call so the list is never empty. Requires the settings:read permission.

GET
https://services.magicdoor.com/settings/company-portal/settings/tenant-portal-invite-templates

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.

Response

200 · The company's templates, in the order they are shown.

idstringrequired

The template's Snowflake id, as a decimal string.

kindenum<string>required

Which message in the invite sequence this template is. Everything the company creates itself is Custom.

WelcomePortalInvitePaymentPasswordChangeCustomPostInviteMaintenancePostInviteImportantDocuments
namestringrequired

What the template is called in the settings screen.

isCustombooleanrequired

true for templates the company created, false for MagicDoor's built-in ones. Only custom templates can be deleted, and only built-in ones can be reset.

emailobjectrequired

The email version of the message.

textobjectrequired

The text-message version of the message.

updatedAtstringrequired

When the template was last saved, formatted as yyyy-MM-dd HH:mm. Unlike timestamps elsewhere in the API this is a display string, not an ISO 8601 value.

updatedByNamestring

The property manager who last saved it, as a first name and last initial. Absent when the last save was not made by a property manager.

401 · The access token is missing, expired, or invalid.

403 · The caller does not hold the `settings:read` permission.

The first call for a company creates any missing built-in templates — Welcome, PortalInvite, Payment, PostInviteMaintenance and PostInviteImportantDocuments — from MagicDoor's defaults, so the response always contains them.

Templates come back in sequence order: Welcome, PortalInvite, Payment, PasswordChange, then the company's own Custom templates oldest first, then anything else.