Add Set-Field Action

Tool name: add-automation-set-field-action

Adds an automation action that sets, clears or calculates a contact field according to customFieldOp (operators from get-automation-editor-capabilities). Running it replaces the prior value. Requires an unscheduled, inactive automation and its current revision from get-automation; dryRun previews without saving. Place it with afterActionId and branch (next after a regular action, yes/no after a decision).

Input schema

automationIdinteger, >= 1required

revisionstring^[a-f0-9]{64}$required

afterActionIdinteger, >= 1required

branchstringrequired

Enum:"next""yes""no"

settingsobjectrequired

dryRunboolean

Default:false

accountIdnull or integer, >= 1

Default:null

Input example

{
  "automationId": 1,
  "revision": "string",
  "afterActionId": 1,
  "branch": "next",
  "settings": {
    "name": "string",
    "color": "",
    "customFieldID": "string",
    "customFieldOp": "set field value",
    "customFieldValue": "string",
    "customFieldValue2": "string",
    "delayDayOfWeek": [
      1
    ]
  },
  "dryRun": false,
  "accountId": null
}

Output schema

automationIdintegerrequired

namestringrequired

revisionstringrequired

statusstringrequired

editorUrlstringrequired

graphobjectrequired

findingsArray of objectsrequired

editablebooleanrequired

dryRunbooleanrequired

settingsArray of any or objectrequired

splitTestsArray of objectsrequired

Output example

{
  "automationId": 0,
  "name": "string",
  "revision": "string",
  "status": "string",
  "editorUrl": "string",
  "graph": {
    "start": 0,
    "goals": [
      0
    ],
    "states": [
      {}
    ]
  },
  "findings": [
    {
      "actionId": 0,
      "code": "string",
      "message": "string",
      "warning": true,
      "variantId": 0
    }
  ],
  "editable": true,
  "dryRun": true,
  "settings": {},
  "splitTests": [
    {}
  ]
}