Time zone support

Cliniko users can enable advanced time zone support for their accounts in their General Settings page. This makes it so every business in the account can have its own time zone set. This time zone can be changed both through Cliniko's user interface, and through the API. This guide describes how the latter works.

Time zone fields in resources

Businesses and other resources with time zone support will contain two fields: time_zone and time_zone_identifier. The first is a "human readable" label for a time zone, suitable for displaying in an interface. The second is an identifier following the IANA standard, which should be compatible with any client library supporting time zones.

To keep our API's behavior consistent with our user interface, the preferred method of changing a resource's time zone is by sending it a new time_zone value, chosen from among the same list of labels we support in the user interface. Cliniko associates each of those to a corresponding IANA time zone value, and will fill the other field accordingly.

It's also possible to send a time_zone_identifier instead. If Cliniko receives one, it will attempt to pair it with a supported time_zone label that has the same basic characteristics (offset and DST transitions). Note that this might result in a label different from what you intended.

If both time_zone and time_zone_identifier are sent, Cliniko will ignore the provided identifier and use the value of time_zone to set the corresponding time_zone_identifier.

We validate that the values provided for both fields are included in our list of supported time zones, which is shown below in its entirety.

Accepted values for time_zone

Accepted values for time_zone_identifier