updateTimezone

Requires at least one of the permissions settings:regional:update or settings:tenant:update.

Changes a timezone's name, offset, daylight-saving rules or sort order. A code already used by another timezone is refused. Setting it as default takes over from the current default. Requires permission to update regional or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateTimezone($id: String!, $updateTimezoneInput: UpdateTimezoneInput!) {
  updateTimezone(id: $id, updateTimezoneInput: $updateTimezoneInput) {
    id
    code
    name
    createdAt
    abbreviation
    deletedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateTimezone($id: String!, $updateTimezoneInput: UpdateTimezoneInput!) {\n  updateTimezone(id: $id, updateTimezoneInput: $updateTimezoneInput) {\n    id\n    code\n    name\n    createdAt\n    abbreviation\n    deletedAt\n  }\n}",
  "variables": {
    "id": "string",
    "updateTimezoneInput": {}
  }
}
EOF

Variables:

{
  "id": "string",
  "updateTimezoneInput": {}
}

Response:

{
  "data": {
    "updateTimezone": {
      "id": "id",
      "code": "string",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "abbreviation": "string",
      "deletedAt": "2025-01-15T00:00:00Z"
    }
  }
}

updateTimezone(
  id: String!
  updateTimezoneInput: UpdateTimezoneInput!
): Timezone!

Arguments

updateTimezone.id ● String! non-null scalar

The ID of the timezone.

updateTimezone.updateTimezoneInput ● UpdateTimezoneInput! non-null input

The fields to change.

Type

Timezone object

A time zone the organization can use.