TRUECALC
MCP

data:deleteNamedRange

Deletes the named range.

Parameters

NameTypeRequiredDescription
sheetstringyes
namestringyesThe named range to remove, e.g. "MyRange".

Returns

NameTypeRequiredDescription
namestringyes
removedbooleanyesWhether a named range by this name actually existed and was removed.

Schema

Request payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Payload",
  "type": "object",
  "properties": {
    "sheet": {
      "type": "string"
    },
    "name": {
      "description": "The named range to remove, e.g. `\"MyRange\"`.",
      "type": "string"
    }
  },
  "required": [
    "sheet",
    "name"
  ]
}

Response payload, as JSON Schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Output",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "removed": {
      "description": "Whether a named range by this name actually existed and was removed.",
      "type": "boolean"
    }
  },
  "required": [
    "name",
    "removed"
  ]
}

On this page