Mailrith Email Marketing

Update an automation

automations_update

DestructiveIdempotent

Updates an existing draft or paused Automation. Before changing a running Automation, read it by ID, retain its status in the current task only, pause it, apply the update, and use bounded direct item reads until is_updating is false. Run preflight, return it to running only if it was running before and preflight passes, and verify the final status. If the update fails before changing the Automation, restore its prior running status when preflight passes. If readiness or the prior status cannot be restored, leave it paused and immediately report the failure; never activate an Automation that was not already running. Effect: workspace-change. Retry after reading the current resource state. Permission: automations:write. API reference: https://mailrith.com/developers/api-reference.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "automation_id": "<automation_id>",
      "body": "<body>"
    },
    "name": "automations_update"
  }
}

Input Schema

Name	Required	Description	Default
`body`	Yes	The exact JSON request body defined by the Mailrith public API contract.
`automation_id`	Yes	The automation identifier.

Output Schema

Name	Required	Description
`error`	No
`response`	No
`request_id`	Yes	The stable correlation ID for this MCP tool invocation.
`operation_id`	Yes	The stable Mailrith public API operation ID.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedNov 2, 2026

addedInput schema / $defs / AutomationStepConfig / properties / connectionId
```
Added value: +{
+  "type": "string"
+}
```

addedInput schema / $defs / AutomationStepConfig / properties / replyToEmail / description

Added value: +"Send Email steps only. Empty uses the sender's current Reply-To. With a Mailrith sending domain, a value must be the workspace owner's verified account email or an address on that sender's domain."

addedOutput schema / $defs / AutomationStepConfig / properties / connectionId
```
Added value: +{
+  "type": "string"
+}
```

addedOutput schema / $defs / AutomationStepConfig / properties / replyToEmail / description

Added value: +"Send Email steps only. Empty uses the sender's current Reply-To. With a Mailrith sending domain, a value must be the workspace owner's verified account email or an address on that sender's domain."

Changed8 schema fields changedSep 3, 2026

addedInput schema / $defs / AutomationStepConfig / properties / subject / description

Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedInput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedInput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello from Mailrith.",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedInput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello from Mailrith.",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

addedOutput schema / $defs / AutomationStepConfig / properties / subject / description

Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedOutput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedOutput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello from Mailrith.",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedOutput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello from Mailrith.",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

Changed8 schema fields changedSep 3, 2026

removedInput schema / $defs / AutomationStepConfig / properties / subject / description

Removed value: -"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedInput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes."

changedInput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello from Mailrith.",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedInput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello from Mailrith.",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

removedOutput schema / $defs / AutomationStepConfig / properties / subject / description

Removed value: -"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedOutput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes."

changedOutput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello from Mailrith.",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedOutput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello from Mailrith.",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

Changed8 schema fields changedAug 17, 2026

addedInput schema / $defs / AutomationStepConfig / properties / subject / description

Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedInput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedInput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello from Mailrith.",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedInput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello from Mailrith.",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

addedOutput schema / $defs / AutomationStepConfig / properties / subject / description

Added value: +"For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedOutput schema / $defs / BroadcastEmailDocument / description

Previous value: -"A structured email document. The root node must use type `doc` and contain supported block nodes."New value: +"A structured email document. The root node must use type `doc` and contain supported block nodes. For Subscriber personalization in email subjects and body text nodes, use Mailrith bracket tokens such as [Subscriber_Name, fallback=\"friend\"] or [Subscriber_Email, fallback=\"\"]. Before using a custom field, call custom_fields_list or custom_fields_get and copy its personalization_token exactly. Do not use Handlebars-style variables such as {{ subscriber.name }}; Mailrith sends them as literal text."

changedOutput schema / $defs / BroadcastEmailDocument / example / content

Previous value: -[
-  {
-    "content": [
-      {
-        "text": "Hello from Mailrith.",
-        "type": "text"
-      }
-    ],
-    "type": "paragraph"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+        "type": "text"
+      }
+    ],
+    "type": "paragraph"
+  }
+]

changedOutput schema / $defs / BroadcastEmailDocument / examples

Previous value: -[
-  {
-    "content": [
-      {
-        "content": [
-          {
-            "text": "Hello from Mailrith.",
-            "type": "text"
-          }
-        ],
-        "type": "paragraph"
-      }
-    ],
-    "type": "doc"
-  }
-]New value: +[
+  {
+    "content": [
+      {
+        "content": [
+          {
+            "text": "Hello [Subscriber_Name, fallback=\"friend\"].",
+            "type": "text"
+          }
+        ],
+        "type": "paragraph"
+      }
+    ],
+    "type": "doc"
+  }
+]

First observedJul 30, 2026

TDQS

A4.3/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations mark this destructive, idempotent, and closed-world, but the description goes far beyond: it defines the pause/restore protocol, the 'never activate an automation that was not already running' invariant, the failure-handling path when readiness cannot be restored, the workspace-change effect, the automations:write permission, and retry-after-read guidance. This is exactly the extra context annotations cannot carry.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in the first sentence, and the remaining sentences are load-bearing safety procedure rather than filler. It is dense and long, and some clauses ('retain its status in the current task only') could be tightened, but nothing is gratuitous.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a destructive mutation with a deeply nested body schema and an output schema, the description covers the operational risks an agent would otherwise get wrong. The remaining gap is update semantics: it does not state whether the supplied definition replaces the whole automation graph or patches it, which matters for a 256-step nested body.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both parameters (automation_id, body) are documented in the schema and the baseline applies. The description adds only the indirect hint 'read it by ID' for automation_id and says nothing about whether the body's definition replaces or merges with the existing one — a meaningful omission given minProperties: 1 — but that is a body-contract concern rather than a parameter one.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence states a specific verb and resource with a scope constraint: 'Updates an existing draft or paused Automation.' That tells an agent exactly which resources this touches. It does not explicitly name the sibling that handles status transitions (automations_update_status), which is the main adjacent risk, so it falls short of 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives an explicit when-to-use split (drafts and paused automations directly; running automations only via a read-pause-update-preflight-resume sequence) and states conditions for restoring prior status. It also names the preflight dependency, so the agent knows which sibling to call and in what order.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Mailrith Email Marketing tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Update an automation

Tool call template

Input Schema

Output Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources