volunteerreminder

Get account overview

Read the current VolunteerReminder account: organization name, plan and entitlements, current reminder send mode, and volunteer usage vs the plan limit. Call this first to understand what the account can do before creating schedules or contacts. Note the `reminder_mode`: an account created through this connector (create_account) starts in `test` (reminders reroute to the owner, never to volunteers); only a human can switch it to `live` from the dashboard. `effective_mode` is what actually happen

List schedules

List all active (non-archived) schedules on the account, each with its description, job/role, next upcoming occurrence, and how many volunteers are rostered. Requires the `read` scope.

Get a schedule

Get one schedule's full configuration: recurrence settings, job/role, group, roster (contact ids), start/end dates, and notes. Requires the `read` scope.

Preview upcoming occurrence dates

PURE and side-effect-free: computes the next occurrence dates a recurrence configuration WOULD produce, without creating anything. Use this to show the user the concrete dates (e.g. 'the next 8 Tuesdays at 9:00 AM Central') and get their confirmation BEFORE calling create_schedule. Requires the `read` scope.

Get upcoming shifts for a schedule

List a schedule's upcoming occurrences (shifts) in a date range, each with its date/time, whether the roster is attending that date, and the assigned volunteers. Requires the `read` scope.

Create a schedule

Create a recurring (or custom-date) schedule and materialize its upcoming occurrences. Best practice: call preview_schedule_occurrences with the same recurrence settings first and confirm the dates with the user. This tool returns the created schedule AND an inline preview of its next occurrences so you can show what was set up. You can optionally seed the roster with contact_ids at creation. Requires the `schedules:write` scope.

Update a schedule

Partially update a schedule — send only the fields you want to change; unset fields keep their current value. Changing recurrence fields recomputes and re-materializes future occurrences. This tool does NOT change the roster; use assign_contacts_to_schedule for that. Requires the `schedules:write` scope.

Archive a schedule

Archive (soft-delete) a schedule. It stops appearing in the active list and no further reminders go out for it, but past reminder history is preserved. This is reversible only from the dashboard. Confirm with the user before archiving. Requires the `schedules:write` scope.

List volunteers

List all volunteers on the account's roster, each with contact details and group. Requires the `read` scope.

Add volunteers

Add one or more volunteers to the roster in a single call. ALL-OR-NOTHING: if the batch would push the account past its plan's volunteer limit, or any contact references a group_id not on this account, NOTHING is added and the error names the limit/count/bad id so you can adjust. Phone numbers are validated and normalized to E.164. Requires the `contacts:write` scope.

Update a volunteer

Update a volunteer's details. Send only the fields you want to change; a field set to null clears it. Requires the `contacts:write` scope.

Remove a volunteer

Remove (soft-delete) a volunteer from the roster. This frees a volunteer-cap slot and removes them from any schedule rosters they were on. Confirm with the user before removing. Requires the `contacts:write` scope.

Set a schedule's roster

Assign volunteers to a schedule. This REPLACES the schedule's entire roster — send the COMPLETE desired set of contact ids, not a delta (pass an empty array to clear it). Every id must belong to this account or the whole request is rejected with the offending ids named. Does not change occurrences. Requires the `contacts:write` scope.

Import a volunteer roster and schedule

Parse a pasted or uploaded volunteer roster + schedule (CSV or a table with columns like name, phone, email, job/role, day, start, end) and either PREVIEW or CREATE the contacts, schedules, and assignments. Always call first with confirm=false and show the user the upcoming shifts; only call again with confirm=true, passing back preview_token from that preview, after they approve. Import is test-mode only and is refused on some accounts. Use create_account first if they do not have an account —

Get open days (who do we still need?)

List calendar days in the look-ahead window that have no attendable shift yet, plus recurring monthly slots not yet claimed by a schedule — i.e. where the account still needs volunteers. Requires the `read` scope.

Get reminder settings

Read the account's reminder lead times (the account-wide default plus any per-job overrides) and which channels (email / SMS) are available on the current plan. Reminder overrides are per JOB, not per individual schedule. Requires the `read` scope.

Get reminder send history

Read recent reminder outcomes — which reminders were sent and which failed — newest first, paginated. Use this to confirm reminders actually went out. Requires the `read` scope.

Set a reminder rule

Set the reminder lead time: the account-wide default and/or a per-job override. Provide at least one of `global_default` or `job_override`, and set at least one of days/hours/minutes greater than zero. Overrides are per JOB (a job may back several schedules). Requires the `reminders:write` scope.

Remove a reminder rule

Remove a reminder lead-time rule. Provide `job_id` to remove that job's override; omit it to clear the account-wide default. Returns the updated reminder settings. Requires the `reminders:write` scope.

Send a test reminder to the account owner

Send a single TEST reminder to the account owner's own email/phone so they can preview what a reminder looks like. This never reaches volunteers — it always reroutes to the owner. Optionally pass a schedule_id to preview that schedule's reminder; otherwise a generic sample is sent. Requires the `reminders:write` scope.

Get pricing and plans

Read VolunteerReminder's public plan catalog: each plan's monthly and annual price (USD), volunteer limit, and included features (SMS reminders are included with no per-message credits or metering). No API key required — use this to help a user comparison-shop or decide which plan fits before they sign up.

Create an account (pending email verification)

Start a new VolunteerReminder account for a human, using their email address. This does NOT finish signup and does NOT return an API key: it emails the person a verification link they must click to activate the account. Nothing can be built on the account and no reminders can ever send until they verify — and even then a new account starts in safe `test` mode (reminders reach only the owner, never volunteers) until a human turns on live sending from the dashboard. Idempotent: calling it again wi

Get a Stripe Checkout link to subscribe

Get a Stripe-hosted Checkout URL for the account to subscribe to a paid plan, then HAND THE URL TO THE HUMAN to open and complete payment. You never take payment yourself and never see card details. Use get_pricing first to pick a plan. Fails if the account already has an active subscription (manage that from the billing dashboard). Requires a connected API key (any scope with `read`).