Reset an invite template

Puts a built-in template's name and wording back to MagicDoor's defaults, discarding the company's edits. Templates the company created itself cannot be reset. 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.

Path parameters

idstringrequired

The template's Snowflake id, as returned by the list endpoint.

example: 1849037281920516096

Response

200 · The template, back at its defaults.

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.

Reset an invite template

Authorization

Path parameters

Response

200 · The template, back at its defaults.

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

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

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

422 · The template is a custom one, and only built-in templates have defaults to go back to.