Docs »

Automations »

Commands »

var.unset

The var.unset: command removes a placeholder using a key path.



start:
  set:
    person:
      name:
        first: Kina
        last: Halpue
      phone: +15551234321
  var.unset:
    inputs:
      key: person:phone
  return:
    person@key: person


Result:


person:
  name:
    first: Kina
    last: Halpue

Syntax

inputs:

Key Req’d  
key: The key path of the value to unset, delimited with colons (:).

output:

The optional placeholder to store the result.

on_simulate:

The commands to run during simulation instead of unsetting the value.

If omitted, the value is not unset during simulation.

on_success:

The commands to run on success.

The optional output: placeholder is set to true if the key was found, and false otherwise.

on_error:

The commands to run on failure. If omitted, the automation exits in the error state.

The output: placeholder receives a dictionary with these keys:

Key  
error The error message.