---
title: "Send a test reminder to the account owner"
method: POST
path: "/api/v1/reminders/test"
tags: ["Reminders"]
---

# Send a test reminder to the account owner

`POST /api/v1/reminders/test`

## Request

- Base URL: `https://volunteerreminder.com`
- URL: `https://volunteerreminder.com/api/v1/reminders/test`
- Auth: HTTP bearer

Send ONE sample reminder to the account OWNER's own email so they can preview what a reminder looks like. It NEVER reaches volunteers — it always targets the owner — so it respects the test-mode safety model trivially. Requires the `reminders:write` scope.

## Request body

- TestReminderRequest
  - `schedule_id` integer: Preview the reminder for this schedule (its job name is used in the sample). Omit for a generic sample. Must belong to this account.

## Response `200`

A test reminder was queued to the owner's email.

- TestReminderResponse
  - `delivered_to` string, required: The account owner's own email the test reminder was sent to.
  - `channel` 'email', required: Test reminders are always email, always to the owner.
  - `schedule_id` number, nullable, required: The schedule previewed, or null for a generic sample.
  - `note` string, required: Human/LLM-readable confirmation of what happened.

## Other responses

- `400`: The request failed schema validation (`validation_error`). On the import endpoints, also when the text is UTF-16 (Excel "Unicode Text"; `unsupported_encoding`): resend it as CSV UTF-8.
- `401`: Missing or invalid API key.
- `403`: The API key lacks a scope required by this endpoint.
- `404`: The requested resource does not exist.

---

[API](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api.md) · [All operations](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/llms.txt) · [OpenAPI document](https://skmtc.dev/volunteerreminder/apis/volunteerreminder-api/revisions/f8e7e26ba96f?raw)
