Sign in
Sites

Update SMS Notification Settings

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

put/shop/sites/{siteId}/sms-settings

Path parameters

siteIdstring uuid required

Identifier of the site whose SMS settings are being read or updated. SMS settings (sender names, default templates, Twilio bindings) are scoped per site so each location can configure its own customer-comms behaviour.

Request body

confirmation_sms_enabledboolean

Whether the order confirmation SMS is enabled.

automated_confirmation_sms_enabledboolean

Whether the order confirmation SMS has automation turned off or not.

cancellation_sms_enabledboolean

Whether the order cancellation SMS is enabled.

pay_by_link_sms_enabledboolean

Whether the pay by link request SMS is enabled.

billing_details_request_sms_enabledboolean

Whether the billing details request SMS for memberships is enabled.

waitlist_confirmation_sms_enabledboolean

Whether the waitlist update SMS is enabled.

reminder_sms_enabledboolean

Whether the reminder SMS is enabled.

automated_reminder_sms_enabledboolean

Whether the order reminder SMS has automation turned off or not.

reminder_sms_timestring time

The time of day the reminder SMS will be sent for automated messages.

reminder_sms_days_aheadinteger

The number of days ahead of the booking the reminder SMS will be sent for automated messages.

follow_up_sms_enabledboolean

Whether the follow up SMS is enabled.

automated_follow_up_sms_enabledboolean

Whether the order follow up SMS has automation turned off or not.

follow_up_sms_timestring time

The time of day the follow up SMS will be sent for automated messages.

follow_up_sms_days_afterinteger

The number of days after the booking the follow up SMS will be sent for automated messages.

sidstring

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.

providerstring

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_numberstring

The phone number the SMS will be sent from.

Example request

{
  "reminder_sms_days_ahead": 3,
  "follow_up_sms_days_after": 3,
  "sid": "SENDERSPA",
  "provider": "twilio",
  "from_number": "+1234567890",
  "confirmation_sms_offerings": [
    {
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "reminder_sms_offerings": [
    {
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "follow_up_sms_offerings": [
    {
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ]
}

Response

The SMS Notification Settings were successfully retrieved

Example response

{
  "data": {
    "reminder_sms_days_ahead": 3,
    "follow_up_sms_days_after": 3,
    "sid": "SENDERSPA",
    "provider": "twilio",
    "confirmation_sms_offerings": [
      {
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "reminder_sms_offerings": [
      {
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "follow_up_sms_offerings": [
      {
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ]
  }
}

Changes

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