Rent Reminders

Generate reminder letter PDF

Generate a formal letter PDF for the reminder using Typst templates. The generated document URL is stored on the reminder.

Permissions required: leases:write

post/leases/{lease_id}/rent-reminders/{reminder_id}/generate-pdf

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-reminders/{reminder_id}/generate-pdf
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
reminder_idstring uuid required

Response

PDF generation result

idstring uuid
statusstring
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.