Sign in
Sites

Update a Site

Use this endpoint to update an existing Site.

put/sites/{siteId}

Request body

namestring

Display name of the site. Shown to customers in the storefront, in the admin UI, on receipts, and on communications. Trimmed; 1-120 characters, must not contain HTML.

localestring

The locale of the site. See Supported Locales for a list of supported locales.

currencystring

The currency of the site. See Supported Currencies for a list of supported currencies.

timezonestring nullable

The site's local timezone as an IANA zone identifier (e.g. Europe/London, America/New_York). All schedule, opening hours and reporting figures are interpreted in this zone, and the value is used to convert UTC timestamps in API responses into local times for display.

property_type'Spa & Leisure Hotel' | 'Spa Hotel' | 'Spa Hotel & Golf' | 'Standalone Leisure' | 'Standalone Spa' | 'Other'

The type of property the site is.

logo_media_idstring uuid nullable

The media ID of the Site's logo.

To obtain a Media ID, use the createMedia endpoint to upload your media.

external_idstring nullable

An external ID for the site This can be used to link the site to an external system.

country_codestring nullable

The country code of the site

Example request

{
  "name": "Palm Tree Spa",
  "locale": "en",
  "currency": "GBP",
  "timezone": "Europe/London",
  "property_type": "Spa & Leisure Hotel",
  "external_id": "ext-site-london-bridge",
  "country_code": "GB"
}

Response

The Site was successfully updated

Example response

{
  "data": {
    "country_code": "GB",
    "currency": "GBP",
    "external_id": "ext-site-london-bridge",
    "frontend_subdomain": "palmtreespa",
    "locale": "en",
    "name": "Palm Tree Spa",
    "organisation_name": "Palm Tree Holdings Ltd.",
    "property_type": "Spa & Leisure Hotel",
    "timezone": "Europe/London"
  }
}

Changes

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