Change sending rules and reminder timing. Switching booking texts on needs acknowledge_estimate: true. Unsent reminders for future bookings move to new timing

put/api/v1/comms/settings

Request

  • Base URL: http://127.0.0.1:4310
  • URL: http://127.0.0.1:4310/api/v1/comms/settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sfb_session

Request body

daily_capinteger
quiet_startstring
quiet_endstring
batch_sizeinteger
batch_interval_secondsinteger
test_addressstring
sms_booking_confirmationboolean
sms_booking_reminderboolean
sms_reminder_hoursinteger
sms_rate_minorinteger
acknowledge_estimateboolean
review_requests_enabledboolean
review_delay_hoursinteger
review_channel'email' | 'sms' | 'whatsapp'
review_requires_marketing_consentboolean
public_review_urlstring
public_review_labelstring
expected_versioninteger
email_booking_reminderboolean

Send an email reminder before each appointment (default true)

email_reminder_hoursinteger

Hours before the appointment for the email reminder (default 24)

sms_reminder_mode'hours_before' | 'day_before_at'

Text reminder a number of hours before (sms_reminder_hours) or at a set local time the day before (sms_reminder_local_time)

sms_reminder_local_timestring

HH:MM in the business time zone, for day_before_at

sms_reminder_local_minuteinteger
sms_payment_linkboolean

Text the deposit link, and a note if the hold expires (default true)

sms_booking_changesboolean

Text when a booking is moved or cancelled (default false)

Example request

{
  "quiet_start": "21:00",
  "quiet_end": "09:00",
  "sms_reminder_local_time": "08:00"
}

Response

OK

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.