> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# updateMarketingAutomation
> Update automation metadata and/or apply step operations. Returns null if no owned automation matches the id. Pass `input`, `operations`, or both.
**Required scopes:** [`marketing_automations_write`](/docs/api-reference/v3/reference/scopes#scope-marketing_automations_write)
## Arguments
The automation's `id`, or its `legacyId` from an earlier version of the Redo API.
UpdateMarketingAutomationInput}>
Metadata fields to change.
The merchant's description. Pass null to clear it.
Whether the automation is running.
The merchant-facing name of the automation.
[MarketingAutomationStepOperation!]}>
Surgical step edits, applied in order.
MarketingAutomationStepInsertInput}>
Insert a new step.
MarketingAutomationAbTestStepInput} />
Insert on the outgoing edge of this parent step.
Insert immediately before this child. The child must have exactly one incoming edge.
MarketingAutomationConditionBranch}>
Which condition arm to attach to.
MarketingAutomationConditionStepInput} />
MarketingAutomationEndStepInput} />
MarketingAutomationManageCustomerTagsStepInput} />
MarketingAutomationManageStaticSegmentStepInput} />
MarketingAutomationSendEmailStepInput}>
Insertable only when the trigger schema has an Email field (not SMS signup).
MarketingAutomationSendSmsStepInput}>
Insertable only when the trigger schema has a Phone field (not email signup, HSA, or extended warranty).
MarketingAutomationSendWebhookStepInput}>
Insert requires an http or https destinationUrl and a payload.
MarketingAutomationStartAgentConversationStepInput}>
Start a Commerce Agent conversation. Insertable when Commerce Agent is enabled, the trigger supports it, and the trigger schema has an Email or Phone field. Requires strategyId.
Which A/B variant arm to attach to.
MarketingAutomationWaitStepInput} />
MarketingAutomationWaitForEventStepInput} />
MarketingAutomationStepMoveInput}>
Move a step.
Place on the outgoing edge of this parent step.
Place immediately before this child.
MarketingAutomationConditionBranch}>
Which condition arm to attach to.
The step to move.
MarketingAutomationStepRemoveInput}>
Remove a step.
The step's id.
MarketingAutomationStepUpdateInput}>
Patch an existing step.
MarketingAutomationAbTestStepInput} />
MarketingAutomationConditionStepInput} />
MarketingAutomationEndStepInput} />
The step's id.
MarketingAutomationManageCustomerTagsStepInput} />
MarketingAutomationManageStaticSegmentStepInput} />
MarketingAutomationSendEmailStepInput} />
MarketingAutomationSendSmsStepInput} />
MarketingAutomationSendWebhookStepInput} />
MarketingAutomationStartAgentConversationStepInput} />
MarketingAutomationTriggerStepInput}>
Patch the trigger. Cannot change key or schemaType.
MarketingAutomationWaitStepInput} />
MarketingAutomationWaitForEventStepInput} />
## Returns
MarketingAutomation}>
A marketing automation: a flow that sends email or SMS to customers when a trigger fires.
MarketingAutomationAnalytics!} required>
Analytics for this marketing automation, grouped by what is being measured.
MarketingAutomationMessagingAnalytics!} required>
Email and SMS performance, read from the analytics warehouse: what was sent, how it was engaged with, and the orders and revenue attributed to it. Covers messages sent by the automation's own send steps; Recover conversations are measured separately and are not included here.
**Requires:** [`marketing_automations_analytics_read`](/docs/api-reference/v3/reference/scopes#scope-marketing_automations_analytics_read)
**Arguments**
How many days after a message an order still counts toward it, 1-30.
Date!} required>
Last day to report on, inclusive, in the store's timezone. The range may span at most 400 days.
Date!} required>
First day to report on, inclusive, in the store's timezone. Must be on or before `endDate`, and the range may span at most 400 days.
**Fields**
[MessageAnalyticsPoint!]!} required>
One entry per day with activity, oldest first. Quiet days are omitted rather than reported as zero.
MessageAnalyticsTotals!} required>
Totals across the whole range. A marketing automation with no activity reports zero counts and null rates.
MarketingAutomationCategory!} required>
Which trigger family this marketing automation belongs to.
DateTime!} required>
When the automation was created.
The merchant's description of what this automation does.
Whether the automation is currently running.
The id of this automation.
The automation's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The merchant-facing name of the automation.
DateTime}>
When the current version was published. Null while it has only ever been a draft.
[MarketingAutomationStep!]!} required>
The nodes that make up this automation, including graph edges as step ids. A type this API version does not model field-by-field is returned as MarketingAutomationUnknownStep.
[JSON!]!} required>
`steps` with every field selected, as JSON: one element per step, with `__typename`. Null and invalid stored steps are \[]. Webhook header values and OAuth client secrets are omitted. Edits go through operations.
DateTime!} required>
When the automation was last updated.
## Example
```graphql theme={null}
mutation {
updateMarketingAutomation(id: "...", input: { ... }, operations: { ... }) {
category
createdAt
description
enabled
id
legacyId
name
publishedAt
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.