Request headers

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Notes

Any workspace user may set the time zone, but ONLY while it is still blank.
Once a time zone is set, this endpoint returns 403; the owner edit path
(workspaces#update) must be used to change an already-set value.

Request body example

{
  "timezone": "America/New_York"
}

Success response body

{
  "id": 1,
  "name": "name",
  "available_users_count": 30,
  "timezone": "America/New_York"
}

Error response body (403) — beta gate (GP-16587, temporary)

While CALENDARS_BETA_ENABLED=true only users granted `calendars_enabled`
may call this endpoint; open to everyone once the variable is off.
Distinguished from the already-set 403 above by the `code` field.
{
  "message": "This feature is not available for your account yet.",
  "code": "feature_not_available"
}

Errors

Code Description
forbidden The workspace time zone is already set and cannot be overwritten here

Params

Param name Description
timezone
required

IANA time zone string; stored as-is (no backend validation)

Validations:

  • Must be a String