Reminders

Send a test reminder to the account owner

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.

post/api/v1/reminders/test

Request

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

Request body

schedule_idinteger

Preview the reminder for this schedule (its job name is used in the sample). Omit for a generic sample. Must belong to this account.

Example request

{
  "schedule_id": 7
}

Response

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

delivered_tostring 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_idnumber nullable required

The schedule previewed, or null for a generic sample.

notestring required

Human/LLM-readable confirmation of what happened.

Example response

{
  "delivered_to": "director@riversidefoodpantry.org"
}

Changes

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