Reminders

Remove a per-job reminder override

Soft-delete the reminder lead-time override for one job (addressed by JOB id). Returns the updated reminder configuration. 404 if the job has no active override on this account. Requires the reminders:write scope.

delete/api/v1/reminder-settings/job-overrides/{id}

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/reminder-settings/job-overrides/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The JOB id whose lead-time override should be removed.

Example:42

Response

The override was removed; the updated configuration.

extra_sentencestring nullable required

Optional extra sentence appended to the fixed reminder wording, or null.

reminder_capinteger required

How many reminders per shift this plan allows (1 / 2 / 3).

Example response

{
  "global_default": {
    "days_before": 1
  },
  "global_defaults": [
    {
      "days_before": 1
    }
  ],
  "job_overrides": [
    {
      "days_before": 1
    }
  ]
}

Changes

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