Reminders

Update the reminder lead times

Set the account-wide default lead time and/or a per-job override. Requires the reminders:write scope. Fails validation (no writes performed) if neither global_default nor job_override is provided, if a lead time leaves all three fields at zero, if job_override.job_id is not a job on this account, or if channels.require_sms is true on a plan without SMS.

put/api/v1/reminder-settings

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/reminder-settings
  • Auth: HTTP bearer

Request body

extra_sentencestring nullable

Optional extra sentence appended to every reminder (max 80 chars). Null or empty clears it.

Example request

{
  "global_defaults": [
    {
      "days_before": 1
    }
  ],
  "global_default": {
    "days_before": 1
  },
  "job_override": {
    "leads": [
      {
        "days_before": 1
      }
    ]
  }
}

Response

The updated reminder 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.