Skip to content

Update Unsubscribe Action

Tool name: update-automation-unsubscribe-action

Updates an automation unsubscribe action's name or colour, not its effect on future contacts. Omitted settings stay; supplied lists replace prior lists. Requires an unscheduled, inactive automation and its current revision from get-automation; dryRun previews without saving.

Input schema

automationIdinteger, >= 1required
actionIdinteger, >= 1required
revisionstring^[a-f0-9]{64}$required
settingsobjectrequired
dryRunboolean
Default:false
accountIdnull or integer, >= 1
Default:null
Input example
{ "automationId": 1, "actionId": 1, "revision": "string", "settings": { "name": "string", "color": "" }, "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": [ {} ] }