Action: Change Sheet Properties

Google Sheets Operation

The Change Sheet Properties action modifies the settings or attributes of a specific sheet.

Example User Story

I want to update the title and locale of a Google Sheet so that it reflects the correct information for my team.

Fields

Field Name	Field Type	Required
spreadsheetId	String	Yes
title	String	No
locale	String	No
timeZone	String	No
fields	String	No

Related Connections

Google Sheets

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "change-sheet-properties",
  "state": "inDev",
  "meta": {
    "short": "Change Sheet Properties",
    "description": "Updates properties of a Google Sheet, such as title, locale, or time zone."
  },
  "input": [
    {
      "name": "spreadsheetId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The spreadsheet to update."
      }
    },
    {
      "name": "title",
      "type": "String",
      "meta": {
        "description": "The title of the spreadsheet."
      }
    },
    {
      "name": "locale",
      "type": "String",
      "meta": {
        "default": "en_US",
        "description": "The locale of the spreadsheet.",
        "options": [
          "af",
          "am",
          "ar",
          "az",
          "be",
          "bg",
          "bn",
          "bs",
          "ca",
          "cs",
          "cy",
          "da",
          "de",
          "el",
          "en",
          "en_AU",
          "en_CA",
          "en_GB",
          "en_IE",
          "en_IN",
          "en_NZ",
          "en_SG",
          "en_US",
          "en_ZA",
          "es",
          "es_419",
          "es_AR",
          "es_BO",
          "es_CL",
          "es_CO",
          "es_CR",
          "es_DO",
          "es_EC",
          "es_GT",
          "es_HN",
          "es_MX",
          "es_NI",
          "es_PA",
          "es_PE",
          "es_PR",
          "es_PY",
          "es_SV",
          "es_UY",
          "es_VE",
          "et",
          "eu",
          "fa",
          "fi",
          "fil",
          "fr",
          "fr_BE",
          "fr_CA",
          "fr_CH",
          "gl",
          "gu",
          "he",
          "hi",
          "hr",
          "hu",
          "hy",
          "id",
          "is",
          "it",
          "it_CH",
          "ja",
          "ka",
          "kk",
          "km",
          "kn",
          "ko",
          "ky",
          "lo",
          "lt",
          "lv",
          "mk",
          "ml",
          "mn",
          "mr",
          "ms",
          "my",
          "ne",
          "nl",
          "nl_BE",
          "no",
          "pa",
          "pl",
          "pt",
          "pt_BR",
          "pt_PT",
          "ro",
          "ru",
          "si",
          "sk",
          "sl",
          "sq",
          "sr",
          "sv",
          "sw",
          "ta",
          "te",
          "th",
          "tr",
          "uk",
          "ur",
          "uz",
          "vi",
          "zh_CN",
          "zh_HK",
          "zh_TW",
          "zu"
        ]
      }
    },
    {
      "name": "timeZone",
      "type": "String",
      "meta": {
        "default": "Etc/GMT",
        "description": "The time zone of the spreadsheet (IANA format).",
        "options": [
          "Africa/Abidjan",
          "Africa/Accra",
          "Africa/Addis_Ababa",
          "Africa/Algiers",
          "Africa/Cairo",
          "Africa/Casablanca",
          "Africa/Johannesburg",
          "Africa/Lagos",
          "Africa/Nairobi",
          "Africa/Tunis",
          "America/Anchorage",
          "America/Argentina/Buenos_Aires",
          "America/Bogota",
          "America/Chicago",
          "America/Denver",
          "America/Halifax",
          "America/Lima",
          "America/Los_Angeles",
          "America/Mexico_City",
          "America/New_York",
          "America/Phoenix",
          "America/Santiago",
          "America/Sao_Paulo",
          "America/St_Johns",
          "America/Toronto",
          "America/Vancouver",
          "Asia/Almaty",
          "Asia/Baghdad",
          "Asia/Bangkok",
          "Asia/Beirut",
          "Asia/Colombo",
          "Asia/Dhaka",
          "Asia/Dubai",
          "Asia/Ho_Chi_Minh",
          "Asia/Hong_Kong",
          "Asia/Jakarta",
          "Asia/Jerusalem",
          "Asia/Kabul",
          "Asia/Karachi",
          "Asia/Kathmandu",
          "Asia/Kolkata",
          "Asia/Kuala_Lumpur",
          "Asia/Kuwait",
          "Asia/Manila",
          "Asia/Muscat",
          "Asia/Nicosia",
          "Asia/Rangoon",
          "Asia/Riyadh",
          "Asia/Seoul",
          "Asia/Shanghai",
          "Asia/Singapore",
          "Asia/Taipei",
          "Asia/Tashkent",
          "Asia/Tehran",
          "Asia/Tokyo",
          "Asia/Ulaanbaatar",
          "Asia/Yekaterinburg",
          "Atlantic/Azores",
          "Atlantic/Cape_Verde",
          "Atlantic/Reykjavik",
          "Australia/Adelaide",
          "Australia/Brisbane",
          "Australia/Darwin",
          "Australia/Hobart",
          "Australia/Melbourne",
          "Australia/Perth",
          "Australia/Sydney",
          "Europe/Amsterdam",
          "Europe/Athens",
          "Europe/Belgrade",
          "Europe/Berlin",
          "Europe/Brussels",
          "Europe/Bucharest",
          "Europe/Budapest",
          "Europe/Copenhagen",
          "Europe/Dublin",
          "Europe/Helsinki",
          "Europe/Istanbul",
          "Europe/Kiev",
          "Europe/Lisbon",
          "Europe/Ljubljana",
          "Europe/London",
          "Europe/Luxembourg",
          "Europe/Madrid",
          "Europe/Minsk",
          "Europe/Moscow",
          "Europe/Oslo",
          "Europe/Paris",
          "Europe/Prague",
          "Europe/Rome",
          "Europe/Sarajevo",
          "Europe/Skopje",
          "Europe/Sofia",
          "Europe/Stockholm",
          "Europe/Tallinn",
          "Europe/Vienna",
          "Europe/Vilnius",
          "Europe/Warsaw",
          "Europe/Zagreb",
          "Europe/Zurich",
          "Pacific/Auckland",
          "Pacific/Fiji",
          "Pacific/Guam",
          "Pacific/Honolulu",
          "Pacific/Midway",
          "Pacific/Noumea",
          "Pacific/Pago_Pago",
          "Pacific/Port_Moresby",
          "Pacific/Tongatapu",
          "UTC"
        ]
      }
    }
  ],
  "output": [
    {
      "name": "spreadsheetId",
      "type": "String",
      "selector": [
        "spreadsheetId"
      ],
      "meta": {
        "description": "The updated spreadsheet ID."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": {
          "value": "/{{spreadsheetId}}:batchUpdate"
        },
        "headers": {
          "Content-Type": {
            "value": "application/json"
          }
        },
        "bodyTemplate": {
          "value": "{\"requests\": [{\"updateSpreadsheetProperties\": {\"properties\": {\"title\": \"{{title}}\", \"locale\": \"{{locale}}\", \"timeZone\": \"{{timeZone}}\"}, \"fields\": \"title,locale,timeZone\"}}]}"
        }
      }
    }
  ]
}