Imports

Preview a roster + schedule import

PURE parse of a pasted CSV/table. Creates nothing. Returns the contacts, schedules, upcoming shifts, and a preview_token that a subsequent POST /imports must send back. Test-mode accounts only; account 3 is refused even in test. Does not change reminder mode. Requires read. Text that is UTF-16 (Excel "Unicode Text") read as UTF-8 or Latin-1 is refused with 400 unsupported_encoding; send CSV UTF-8 text.

post/api/v1/imports/preview

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/imports/preview
  • Auth: HTTP bearer

Request body

textstring required

CSV, TSV, pipe-delimited, or a headerless table. Recognized columns: name, phone, email, job/role, day, date, start, end. Header aliases (volunteer, weekday, from, …) are accepted. Max ~500 data rows.

Example request

{
  "text": "name,phone,email,job,day,start,end\nJane Doe,512-555-0100,jane@pantry.org,Greeter,Tuesday,9:00 AM,12:00 PM"
}

Response

Parsed preview. ok is false when nothing usable was found.

okboolean required
row_countnumber required
skipped_row_countnumber required
reminder_mode'test' | 'live' required
reminder_mode_notestring required
preview_tokenstring required

Changes

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