---
title: "Generate reminder letter PDF"
method: POST
path: "/leases/{lease_id}/rent-reminders/{reminder_id}/generate-pdf"
tags: ["Rent Reminders"]
---

# Generate reminder letter PDF

`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

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

**Permissions required:** `leases:write`

## Path parameters

- `lease_id` string, uuid, required
- `reminder_id` string, uuid, required

## Response `200`

PDF generation result

- object
  - `id` string, uuid
  - `status` string
  - `message` string

## Other responses

- `404`: Reminder not found

---

[API](https://skmtc.dev/faireplace/apis/faireplace-property-management-api.md) · [All operations](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faireplace/apis/faireplace-property-management-api/revisions/69de39762919?raw)