Skip to main content

Remove Property

Removes a property from an object by its key.

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​

  • Object - The object from which to remove the property.
  • Key - The property key name to remove (string). Cannot be empty.

Options​

This node does not have any options.

Outputs​

  • Object - The object with the specified property removed.

How It Works​

The Remove Property node removes a property from an object. When executed, the node:

  1. Receives an object through the Object input
  2. Validates that the object is not null
  3. Receives a property key name through the Key input
  4. Validates that the key is not empty
  5. Removes the property with the specified key from the object
  6. Applies appropriate thread-safety locks for Global or Flow scopes
  7. Outputs the modified object through the Object output

Requirements​

  • Valid object as input (cannot be null)
  • Non-empty string for the key name

Error Handling​

The node will return specific errors in the following cases:

  • ErrInvalidArg - Object is null or undefined
  • ErrInvalidArg - Key is empty or null

Usage Notes​

  • If the specified key does not exist, the object remains unchanged (no error is thrown)
  • The node modifies the original object and returns it
  • Global and Flow scope objects are protected with mutex locks for thread-safe updates
  • Only removes top-level properties, not nested properties
  • Can be chained with other Remove Property nodes to remove multiple properties
  • Useful for data sanitization and filtering workflows
  • Helps reduce object size by removing unnecessary properties
  • Can be used to remove sensitive data before logging or sending objects

Example Use Cases​

Remove Sensitive Data​

Remove password or sensitive fields before logging:

Get User Object →
  Remove Property (Key: "password") →
  Remove Property (Key: "creditCard") →
  Log Sanitized Object

Clean API Response​

Remove unnecessary fields from API response:

Get API Response →
  Remove Property (Key: "internal_id") →
  Remove Property (Key: "metadata") →
  Return Clean Response

Data Filtering​

Filter object properties based on conditions:

Get Object →
  For Each Unwanted Key →
    Remove Property (Key: current_key) →
  Return Filtered Object

Prepare Export Data​

Remove system fields before export:

Get Database Record →
  Remove Property (Key: "created_at") →
  Remove Property (Key: "updated_at") →
  Remove Property (Key: "id") →
  Export to CSV

Object Transformation​

Transform object structure by removing old properties:

Get Old Format Object →
  Add New Properties →
  Remove Property (Key: "deprecated_field1") →
  Remove Property (Key: "deprecated_field2") →
  Save New Format

Conditional Property Removal​

Remove properties based on business logic:

Get Object →
  If condition met →
    Remove Property (Key: "optional_field") →
  Continue Processing

Tips for Effective Use​

  • Always validate that the object exists before attempting to remove properties
  • Removing a non-existent key is safe and won't cause an error
  • Use Get Keys first if you need to verify the key exists before removal
  • Chain multiple Remove Property nodes to clean objects efficiently
  • Consider creating a reusable flow for common sanitization patterns
  • Use with loops to remove multiple properties dynamically
  • Helpful for GDPR compliance by removing personal data
  • Can reduce payload size for API calls or data transfers
  • Store cleaned objects in Message scope for temporary use
  • Use Flow or Global scope when the cleaned object needs to be shared