toggleTimezoneActive

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

Switches a timezone on or off, whichever it is not now. 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 ToggleTimezoneActive($id: String!) {
  toggleTimezoneActive(id: $id) {
    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 ToggleTimezoneActive($id: String!) {\n  toggleTimezoneActive(id: $id) {\n    id\n    code\n    name\n    createdAt\n    abbreviation\n    deletedAt\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

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

toggleTimezoneActive(
  id: String!
): Timezone!

Arguments

toggleTimezoneActive.id ● String! non-null scalar

The ID of the timezone.

Type

Timezone object

A time zone the organization can use.