---
schema_version: "1"
id: 81d302f8cfaeb3a6ee4041775f8662a83ab026a03580162fd083e267d9bfbacf
title: Action Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_requests_action_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_requests_action_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b3744f58ff1972134818f91c8b05974ecb5afe2aca210ad1071cc20089f845bb
description: The action for a rule or macro to perform during a JSON transformation.
---
# Action Input

The action for a rule or macro to perform during a JSON transformation.

Properties

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d17692e61">Parameter Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d17692e64">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d17692e67">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d17692e70">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d17692e73">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">action</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">Connect​Action​Type​Enum</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The action types. Valid values are: <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">Add</samp> - Add a value to an existing array in the JSON tree.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Delete</samp> - Delete an attribute or node from the JSON tree.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Eval</samp> - Evaluate an expression, usually for a macro definition.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Put</samp> - Insert an attribute or node into the JSON tree.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Replace</samp> - Performs a global search and replace on the entire JSON document.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Set</samp> - Set the value of an existing attribute in the JSON tree.
                      </li>

                    </ul>
                  </td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">condition</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">String</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The condition to meet for the action to be run.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">description</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">String</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The description of the action.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">index</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">Integer</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The index into an array. Use with <samp class="codeph nolang">Add</samp> actions.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">key</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">String</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The key of the action. Use with <samp class="codeph nolang">Put</samp> actions.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">path</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">String</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The JSON path to perform the action on.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d17692e61" data-title="Parameter Name"><samp class="codeph nolang">value</samp></td>

                  <td class="entry" headers="d17692e64" data-title="Type">String</td>

                  <td class="entry" headers="d17692e67" data-title="Description">The value of the action. Use with all actions expect the <samp class="codeph nolang">Delete</samp> action.</td>

                  <td class="entry" headers="d17692e70" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d17692e73" data-title="Available Version">43.0</td>

                </tr>

              </tbody>

            </table>