Skip to main content
Resolve an action parameter whose options or fields depend on other inputs — a dependent dropdown’s values, or a field set revealed by an earlier choice. Get the packageId and actionKey from clay workflows actions list, and the parameter names from clay workflows actions schema. Configuring cascading inputs is iterative: resolve and fill one input, then re-run with it in --inputs to resolve the next dependent parameter. 
clay workflows actions dynamic-fields <packageId> <actionKey> <parameterPath> [--type <type>] [--account <id>] [--inputs <json|file|->]

​
Arguments

ArgumentDescription
packageIdAction package id, from workflows actions list. Required.
actionKeyAction key, from workflows actions list. Required.
parameterPathParameter name; use dot-notation for grouped params (e.g. objectSchema.stage). Required.

​
Flags

FlagDescription
--type <type>select resolves a dependent dropdown’s values; input resolves a revealed field set. Defaults to select.
--account <id>Connected account id (authAccountId) for actions that need auth.
--inputs <json|file|->Already-chosen input values as a JSON object keyed by parameter name: inline JSON, a file path, or - for stdin.

​
Output

The command returns an array of resolved parameters. The dynamicData shape depends on --type. errors[].isBlocking is load-bearing: when it is true, abort cascading input resolution. 
[
  {
    "parameterPath": "property",
    "dynamicData": [{ "value": "companies", "displayName": "Companies" }],
    "errors": [
      {
        "errorMessage": "Account not connected.",
        "errorStatus": "auth_error",
        "isBlocking": true
      }
    ],
    "logUrl": "https://..."
  }
]
FieldTypeDescription
parameterPathstringThe resolved parameter.
dynamicDataarrayResolved values or fields; shape depends on --type (see below).
errorsarray (optional)Resolution errors. Each has errorMessage, optional errorDetails, errorStatus, and isBlocking.
logUrlstring (optional)Link to server logs for this resolution.
dynamicData by --type: | --type | dynamicData shape | | -------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | select | [ { "value": <string>, "displayName": <string> } ] — value is what you pass back in a later --inputs call. | | input | Revealed input-parameter schema objects forwarded from the server. Each name is prefixed to pipe notation (<parameterPath> | <field>) so it can be bound directly — the bare name drops the value at run time. |

​
Errors

CodeExitNotes
validation_error2Required arguments missing, or --inputs is unreadable, not valid JSON, or not a JSON object.
auth_forbidden3The API key lacks permission for this command.

​
Examples

clay workflows actions dynamic-fields <packageId> create-object objectType --account acc_123 | jq '.[0].dynamicData'
clay workflows actions dynamic-fields <packageId> create-object property --account acc_123 --inputs '{"objectType":"companies"}' | jq -r '.[0].dynamicData[].value'