---
title: "Update SMS Notification Settings"
method: PUT
path: "/shop/sites/{siteId}/sms-settings"
tags: ["Sites"]
---

# Update SMS Notification Settings

`PUT /shop/sites/{siteId}/sms-settings`

This endpoint updates the SMS Notification Settings for the given site.

## Path parameters

- `siteId` string, uuid, required

## Request body

- object
  - `confirmation_sms_enabled` boolean — Whether the order confirmation SMS is enabled.
  - `automated_confirmation_sms_enabled` boolean — Whether the order confirmation SMS has automation turned off or not.
  - `cancellation_sms_enabled` boolean — Whether the order cancellation SMS is enabled.
  - `pay_by_link_sms_enabled` boolean — Whether the pay by link request SMS is enabled.
  - `billing_details_request_sms_enabled` boolean — Whether the billing details request SMS for memberships is enabled.
  - `waitlist_confirmation_sms_enabled` boolean — Whether the waitlist update SMS is enabled.
  - `reminder_sms_enabled` boolean — Whether the reminder SMS is enabled.
  - `automated_reminder_sms_enabled` boolean — Whether the order reminder SMS has automation turned off or not.
  - `reminder_sms_time` string, time — The time of day the reminder SMS will be sent for automated messages.
  - `reminder_sms_days_ahead` integer — The number of days ahead of the booking the reminder SMS will be sent for automated messages.
  - `follow_up_sms_enabled` boolean — Whether the follow up SMS is enabled.
  - `automated_follow_up_sms_enabled` boolean — Whether the order follow up SMS has automation turned off or not.
  - `follow_up_sms_time` string, time — The time of day the follow up SMS will be sent for automated messages.
  - `follow_up_sms_days_after` integer — The number of days after the booking the follow up SMS will be sent for automated messages.
  - `sid` string — The sender identifier registered with the SMS gateway. For Twilio this is the alphanumeric sender ID or Messaging Service SID; recipients see it as the "from" name on the text. Country restrictions on alphanumeric sender IDs apply.
  - `provider` string — Which SMS gateway sends outbound texts for this site. Only `twilio` is supported today; new sites should leave this at the default and configure Twilio credentials separately in the integrations section.
  - `from_number` string — The phone number the SMS will be sent from.
  - `confirmation_sms_offerings` OfferingIdentifier[] — The offerings that automated confirmation texts are sent for. If empty, confirmation texts are sent for all offerings.
    - `offering_id` string, mongo-id, required — The ID of the offering.
    - `offering_name` string, required — The name of the offering.
    - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
  - `reminder_sms_offerings` OfferingIdentifier[] — The offerings that automated reminder texts are sent for. If empty, reminder texts are sent for all offerings.
    - `offering_id` string, mongo-id, required — The ID of the offering.
    - `offering_name` string, required — The name of the offering.
    - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
  - `follow_up_sms_offerings` OfferingIdentifier[] — The offerings that automated follow up texts are sent for. If empty, follow up texts are sent for all offerings.
    - `offering_id` string, mongo-id, required — The ID of the offering.
    - `offering_name` string, required — The name of the offering.
    - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.

## Response `200`

The SMS Notification Settings were successfully retrieved

- object
  - `data` SmsNotificationSettings, required
    - `id` string, uuid, required — The ID of the SMS Notification Settings.
    - `confirmation_sms_enabled` boolean, required — Whether the order confirmation SMS is enabled.
    - `automated_confirmation_sms_enabled` boolean, required — Whether the order confirmation SMS has automation turned off or not.
    - `cancellation_sms_enabled` boolean, required — Whether the order cancellation SMS is enabled.
    - `pay_by_link_sms_enabled` boolean, required — Whether the pay by link request SMS is enabled.
    - `billing_details_request_sms_enabled` boolean, required — Whether the billing details request SMS for memberships is enabled.
    - `waitlist_confirmation_sms_enabled` boolean, required — Whether the waitlist update SMS is enabled.
    - `reminder_sms_enabled` boolean, required — Whether the reminder SMS is enabled.
    - `automated_reminder_sms_enabled` boolean, required — Whether the order reminder SMS has automation turned off or not.
    - `reminder_sms_time` string, time, required — The time of day the reminder SMS will be sent for automated messages.
    - `reminder_sms_days_ahead` integer, required — The number of days ahead of the booking the reminder SMS will be sent for automated messages.
    - `follow_up_sms_enabled` boolean, required — Whether the follow up SMS is enabled.
    - `automated_follow_up_sms_enabled` boolean, required — Whether the order follow up SMS has automation turned off or not.
    - `follow_up_sms_time` string, time, required — The time of day the follow up SMS will be sent for automated messages.
    - `follow_up_sms_days_after` integer, required — The number of days after the booking the follow up SMS will be sent for automated messages.
    - `sid` string, required — The sender identifier registered with the SMS gateway. For Twilio this is the alphanumeric sender ID or Messaging Service SID; recipients see it as the "from" name on the text. Country restrictions on alphanumeric sender IDs apply.
    - `provider` string, required — Which SMS gateway sends outbound texts for this site. Only `twilio` is supported today; new sites should leave this at the default and configure Twilio credentials separately in the integrations section.
    - `from_number` string, required — The phone number the SMS will be sent from.
    - `confirmation_sms_offerings` OfferingIdentifier[], nullable — The offerings that automated confirmation texts are sent for. If empty, confirmation texts are sent for all offerings.
      - `offering_id` string, mongo-id, required — The ID of the offering.
      - `offering_name` string, required — The name of the offering.
      - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
    - `reminder_sms_offerings` OfferingIdentifier[], nullable — The offerings that automated reminder texts are sent for. If empty, reminder texts are sent for all offerings.
      - `offering_id` string, mongo-id, required — The ID of the offering.
      - `offering_name` string, required — The name of the offering.
      - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
    - `follow_up_sms_offerings` OfferingIdentifier[], nullable — The offerings that automated follow up texts are sent for. If empty, follow up texts are sent for all offerings.
      - `offering_id` string, mongo-id, required — The ID of the offering.
      - `offering_name` string, required — The name of the offering.
      - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found
- `422` — The request didn't pass validation

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)
