Create an invite template

Adds a company-authored tenant portal invite template. The new template's kind is always Custom. Requires the settings:write permission.

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.

Body

application/json

namestringrequired

What to call the template. If the company already has a template with this name, a number is appended to make it unique.

emailobjectrequired

The email version of the message.

textobjectrequired

The text-message version of the message.

Response

200 · The template that was created.

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.

400 · A required field is missing from the body.

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

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

A name already in use is not rejected. MagicDoor appends a number — Renewal reminder 1, then Renewal reminder 2 — and returns the name it settled on.