Skip to main content

Delete Value

Removes a key-value pair from a JSON object.

Common Properties

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs

  • Payload - JSON object from which to delete a key-value pair.
  • Key - The key of the value to delete from the JSON object.

Options

  • Escape - Whether to escape dots in the key name (useful for nested keys with dots).

Outputs

  • Payload - Modified JSON object with the specified key-value pair removed.

How It Works

The Delete Value node removes a specified key-value pair from a JSON object. When executed, the node:

  1. Receives a JSON object through the Payload input
  2. Receives a key name through the Key input
  3. Optionally escapes dots in the key name if the Escape option is enabled
  4. Removes the specified key-value pair from the JSON object
  5. Outputs the modified JSON object through the Payload output

Requirements

  • Valid JSON object as input
  • Valid key name to delete

Error Handling

The node will return specific errors in the following cases:

  • Invalid JSON object in the Payload input
  • Invalid key name in the Key input
  • Key not found in the JSON object

Usage Notes

  • This node is useful for removing unwanted data from JSON objects
  • Works with nested JSON objects using dot notation (e.g., "user.name")
  • The Escape option is useful when key names contain dots that should be treated as literal characters
  • The node preserves all other key-value pairs in the object
  • Can be used multiple times in sequence to remove multiple keys
  • Works with any valid JSON structure including objects, arrays, strings, numbers, and booleans
  • The output object maintains the same structure as the input with only the specified key removed
  • Useful for data cleaning and privacy protection by removing sensitive information