Optimly Developer Documentation

Optimly MCP

Record Action Started

In short

Record that an external execution action started. Never use for BrandVault updates: brand_update and brand_publish perform the start and approval consumption atomically.

record_action_started · Approval required · Authentication required

Record that an external execution action started. Never use for BrandVault updates: brand_update and brand_publish perform the start and approval consumption atomically.

When to use

Use when execution happens outside Optimly — for example publishing a page on the brand's own CMS — and the ledger should reflect that it began.

Access

Approved access with action-management permission

Parameters

ParameterTypeRequiredDescription
action_iduuidYesExecution action that started.
actor{ type, id }YesActor identity; type is human, agent, or system.
approval_iduuidNoApproval consumed by this execution, when required.
input_summaryobjectNoBounded summary of execution input.
external_referencestringNoExternal system reference.
external_urlstringNoExternal URL for the work.
brand_iduuidNoAuthorized brand ID. Required when more than one brand is available.

Example prompt

Record that we started publishing the approved FAQ page on our CMS.

Side effects and safety

Appends a started event to the action's status history.