Schedules

Archive a schedule

Soft-deletes (archives) the schedule; past reminder history is preserved. Requires the schedules:write scope.

delete/api/v1/schedules/{id}

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/schedules/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The schedule's numeric id.

Example:42

Response

Archive confirmation.

idnumber required

The archived schedule's id.

archivedtrue required

Always true — the schedule was soft-deleted (archived), not hard-deleted.

Changes

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