Sign in
Sites

Show SMS Notification Settings

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

get/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.

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.