{ "data": { "tool": { "category": "email", "endpoint": "https://api.mailrith.com/mcp", "jsonUrl": "https://www.anchorterminal.com/api/v1/tools/mailrith.json", "kind": "mcp", "listed": "indexed", "liveUrl": "https://www.anchorterminal.com/api/v1/live/mailrith.json", "markdownUrl": "https://www.anchorterminal.com/tools/mailrith.md", "mcpTools": { "check": { "checker": "anchor-check/1.0", "totalTokens": 127059, "counts": { "error": 0, "note": 0, "warn": 75 }, "findings": [ { "rule": "TC13", "severity": "warn", "tool": "analytics_create_report", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "automations_create", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "automations_send_test", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "automations_update", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "automations_update_status", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "broadcasts_create", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "broadcasts_schedule", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "broadcasts_send_test", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "broadcasts_update", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "email_templates_create", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "email_templates_preview", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "email_templates_update", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "segments_preview", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "sequences_create", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "sequences_send_test", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "sequences_update", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "sequences_update_status", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "subscribers_update", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "subscribers_update_status", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "subscribers_upsert", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC13", "severity": "warn", "tool": "tags_create", "message": "body (object with no properties)", "fix": "Declare the properties (or additionalProperties with a schema) and the array's items." }, { "rule": "TC15", "severity": "warn", "tool": "analytics_create_report", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "automations_create", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "automations_send_test", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "automations_update", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "automations_update_status", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "broadcasts_create", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "broadcasts_schedule", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "broadcasts_send_test", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "broadcasts_update", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "email_templates_create", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "email_templates_preview", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "email_templates_update", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "segments_preview", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "sequences_create", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "sequences_send_test", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "sequences_update", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "sequences_update_status", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "subscribers_update", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "subscribers_update_status", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "subscribers_upsert", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC15", "severity": "warn", "tool": "tags_create", "message": "inputSchema uses $ref/$defs", "fix": "Inline the referenced schemas. Pydantic and zod-to-json-schema emit $defs for nested models; most can be told not to." }, { "rule": "TC21", "severity": "warn", "tool": "segments_list", "message": "described almost the same as sequences_list (83% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "segments_list", "message": "described almost the same as automations_list (83% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "sequences_create", "message": "described almost the same as automations_create (81% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "sequences_list", "message": "described almost the same as automations_list (88% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "sequences_update", "message": "described almost the same as automations_update (92% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "subscribers_add_tag", "message": "described almost the same as subscribers_add_to_sequence (89% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "tags_list", "message": "described almost the same as segments_list (83% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "tags_list", "message": "described almost the same as sequences_list (88% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC21", "severity": "warn", "tool": "tags_list", "message": "described almost the same as automations_list (88% of the same words)", "fix": "Say in each description when to use it instead of the other." }, { "rule": "TC22", "severity": "warn", "tool": "automations_create", "message": "the definition is about 6,535 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "automations_get", "message": "the definition is about 3,698 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "automations_update", "message": "the definition is about 6,660 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "automations_update_status", "message": "the definition is about 3,817 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_create", "message": "the definition is about 4,431 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_get", "message": "the definition is about 2,646 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_schedule", "message": "the definition is about 2,918 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_send", "message": "the definition is about 2,963 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_unschedule", "message": "the definition is about 2,675 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "broadcasts_update", "message": "the definition is about 4,572 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "discovery_get_capabilities", "message": "the definition is about 2,694 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "email_templates_create", "message": "the definition is about 3,197 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "email_templates_get", "message": "the definition is about 2,024 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "email_templates_update", "message": "the definition is about 3,124 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "segments_preview", "message": "the definition is about 1,515 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "sequences_create", "message": "the definition is about 6,238 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "sequences_get", "message": "the definition is about 3,905 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "sequences_update", "message": "the definition is about 6,358 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "sequences_update_status", "message": "the definition is about 4,023 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "subscribers_list", "message": "the definition is about 1,675 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "subscribers_update", "message": "the definition is about 1,512 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "subscribers_update_status", "message": "the definition is about 1,692 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC22", "severity": "warn", "tool": "subscribers_upsert", "message": "the definition is about 1,997 tokens", "fix": "Trim the description and parameter docs, or split the tool." }, { "rule": "TC23", "severity": "warn", "message": "55 tools, about 118,968 tokens of definitions", "fix": "Split the server by job, or offer a smaller default toolset (a read-only set, or a search-then-call pattern)." } ] }, "checkedAt": "2026-10-05T22:34:34Z", "count": 55, "schemaTokens": 127059, "status": "ok", "tools": [ { "name": "discovery_get_capabilities", "title": "Get authenticated API capabilities", "description": "Returns the current workspace context, discovery URLs, shared request conventions, supported webhook events, and public resource operations available to the authenticated bearer credential. Permission: none. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "outputSchema": { "$defs": { "Capabilities": { "properties": { "authentication": { "properties": { "header_name": { "type": "string" }, "header_value_prefix": { "type": "string" }, "scopes_supported": { "items": { "type": "string" }, "type": "array" }, "supported_credential_types": { "items": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "type": "array" }, "type": { "enum": [ "bearer" ], "type": "string" }, "workspace_scoped": { "type": "boolean" } }, "required": [ "type", "header_name", "header_value_prefix", "workspace_scoped", "scopes_supported", "supported_credential_types" ], "type": "object" }, "capability_mode": { "description": "Resources contain only operations currently available to this credential, plan, workspace state, rollout state, and active MCP client catalog when called through MCP.", "enum": [ "effective" ], "type": "string" }, "conventions": { "properties": { "idempotency_header": { "type": "string" }, "pagination_cursor_param": { "type": "string" }, "pagination_limit_param": { "type": "string" }, "pagination_type": { "enum": [ "cursor" ], "type": "string" } }, "required": [ "pagination_type", "pagination_limit_param", "pagination_cursor_param", "idempotency_header" ], "type": "object" }, "credential": { "oneOf": [ { "properties": { "created_at": { "format": "date-time", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "key_preview": { "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "scopes": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "active", "expired", "revoked", "rotated" ], "type": "string" }, "type": { "enum": [ "workspace_api_key" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "type", "id", "name", "status", "scopes", "key_preview", "created_at", "updated_at" ], "type": "object" }, { "properties": { "client": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_at": { "format": "date-time", "type": "string" }, "created_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "last_authorized_by_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "scopes": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "active" ], "type": "string" }, "token_preview": { "type": "string" }, "type": { "enum": [ "oauth_access_token" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "type", "id", "status", "scopes", "token_preview", "client", "created_by_user_id", "last_authorized_by_user_id", "expires_at", "created_at", "updated_at" ], "type": "object" } ] }, "discovery": { "properties": { "agents_url": { "type": "string" }, "documentation_url": { "type": "string" }, "llms_full_url": { "type": "string" }, "llms_url": { "type": "string" }, "mcp_docs_url": { "type": "string" }, "mcp_url": { "type": "string" }, "oauth_authorization_server_url": { "type": "string" }, "openapi_url": { "type": "string" }, "python_sdk_url": { "type": "string" }, "reference_url": { "type": "string" }, "sdk_docs_url": { "type": "string" }, "typescript_sdk_url": { "type": "string" }, "webhook_subscriptions_url": { "type": "string" } }, "required": [ "documentation_url", "reference_url", "agents_url", "sdk_docs_url", "typescript_sdk_url", "python_sdk_url", "mcp_docs_url", "mcp_url", "llms_url", "llms_full_url", "openapi_url", "webhook_subscriptions_url", "oauth_authorization_server_url" ], "type": "object" }, "events": { "$ref": "#/$defs/WebhookEventSupport" }, "limitations": { "description": "Current plan or workspace prerequisites that caused otherwise supported operations to be omitted.", "items": { "properties": { "affected_operation_ids": { "description": "Exact operation IDs omitted because of this limitation.", "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "message": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" } }, "required": [ "code", "message", "affected_operation_ids" ], "type": "object" }, "type": "array" }, "mcp": { "$ref": "#/$defs/PublicApiMcp" }, "resources": { "items": { "$ref": "#/$defs/CapabilityResource" }, "type": "array" }, "sdks": { "$ref": "#/$defs/PublicApiSdks" }, "version": { "type": "string" }, "workspace": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "required": [ "version", "workspace", "authentication", "credential", "discovery", "sdks", "mcp", "conventions", "capability_mode", "limitations", "events", "resources" ], "type": "object" }, "CapabilityOperation": { "properties": { "method": { "type": "string" }, "operation_id": { "type": "string" }, "path": { "type": "string" }, "required_scopes": { "items": { "type": "string" }, "type": "array" }, "summary": { "type": "string" } }, "required": [ "method", "path", "operation_id", "summary", "required_scopes" ], "type": "object" }, "CapabilityResource": { "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "operations": { "items": { "$ref": "#/$defs/CapabilityOperation" }, "type": "array" } }, "required": [ "key", "name", "description", "operations" ], "type": "object" }, "PublicApiMcp": { "properties": { "active_operation_ids": { "anyOf": [ { "description": "Exact operation IDs exposed by this MCP client's active tool catalog. Omitted for direct REST requests and unrestricted MCP clients.", "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "active_toolsets": { "anyOf": [ { "description": "Toolsets selected for this MCP request. Omitted for direct REST requests.", "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "docs_url": { "type": "string" }, "package_name": { "type": "string" }, "read_only": { "description": "True when this MCP request is restricted to read-only operations.", "type": "boolean" }, "recommended_transport": { "enum": [ "streamable_http" ], "type": "string" }, "server_url": { "type": "string" }, "supported_transports": { "items": { "enum": [ "streamable_http", "stdio" ], "type": "string" }, "type": "array" } }, "required": [ "package_name", "docs_url", "server_url", "recommended_transport", "supported_transports" ], "type": "object" }, "PublicApiSdks": { "properties": { "python": { "properties": { "docs_url": { "type": "string" }, "language": { "enum": [ "python" ], "type": "string" }, "package_name": { "type": "string" } }, "required": [ "package_name", "docs_url", "language" ], "type": "object" }, "typescript": { "properties": { "docs_url": { "type": "string" }, "language": { "enum": [ "typescript" ], "type": "string" }, "package_name": { "type": "string" } }, "required": [ "package_name", "docs_url", "language" ], "type": "object" } }, "required": [ "typescript", "python" ], "type": "object" }, "WebhookEventSupport": { "properties": { "signing": { "$ref": "#/$defs/WebhookSigning" }, "subscriptions_url": { "type": "string" }, "supported_event_patterns": { "items": { "type": "string" }, "type": "array" }, "supported_events": { "items": { "type": "string" }, "type": "array" } }, "required": [ "subscriptions_url", "supported_events", "supported_event_patterns", "signing" ], "type": "object" }, "WebhookSigning": { "properties": { "algorithm": { "enum": [ "hmac-sha256" ], "type": "string" }, "id_header": { "type": "string" }, "signature_header": { "type": "string" }, "signature_prefix": { "type": "string" }, "timestamp_header": { "type": "string" } }, "required": [ "algorithm", "id_header", "timestamp_header", "signature_header", "signature_prefix" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getPublicApiCapabilities", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Capabilities" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get authenticated API capabilities" } }, { "name": "workspace_get", "title": "Get the current workspace", "description": "Returns the authenticated workspace profile and mailing context used by broadcasts, sequences, automations, forms, and magic links. Permission: workspace:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "outputSchema": { "$defs": { "Workspace": { "properties": { "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "description": "Country for the workspace address.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "postal_code": { "anyOf": [ { "description": "Postal or ZIP code for the workspace address.", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "state": { "anyOf": [ { "description": "State, province, or region for the workspace address.", "type": "string" }, { "type": "null" } ] }, "time_zone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "logo", "address", "city", "state", "postal_code", "country", "time_zone", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getWorkspace", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Workspace" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get the current workspace" } }, { "name": "sender_identities_list", "title": "List sender identities", "description": "Returns a bounded page of enabled sender names, addresses, and provider types that can be selected for Broadcasts and Sequences. Provider credentials and configuration are never returned. Permission: workspace:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of sender identities to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "starting_after": { "description": "Opaque next_cursor returned by the previous sender identity page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "SenderIdentity": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "from_email": { "format": "email", "type": "string" }, "from_name": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "description": "The configured email delivery provider. No provider credentials or configuration are returned.", "type": "string" }, "ready_for_selection": { "description": "True because this read returns only enabled sender identities linked to the current workspace.", "enum": [ true ], "type": "boolean" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "provider", "from_name", "from_email", "ready_for_selection", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listSenderIdentities", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/SenderIdentity" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List sender identities" } }, { "name": "sender_identities_get", "title": "Get a sender identity", "description": "Returns one enabled sender name, address, and provider type by stable identifier. Provider credentials and configuration are never returned. Permission: workspace:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sender_identity_id": { "description": "The sender identity identifier.", "type": "string" } }, "required": [ "sender_identity_id" ], "type": "object" }, "outputSchema": { "$defs": { "SenderIdentity": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "from_email": { "format": "email", "type": "string" }, "from_name": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "description": "The configured email delivery provider. No provider credentials or configuration are returned.", "type": "string" }, "ready_for_selection": { "description": "True because this read returns only enabled sender identities linked to the current workspace.", "enum": [ true ], "type": "boolean" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "provider", "from_name", "from_email", "ready_for_selection", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getSenderIdentity", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/SenderIdentity" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a sender identity" } }, { "name": "analytics_create_report", "title": "Create or reuse an analytics report", "description": "Runs from compact rollups. Ranges through 31 days complete inline; longer ranges are queued. Results expire after 24 hours and never exceed 100 rows. Effect: workspace-change. Retry with the same idempotency_key. Permission: analytics:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AnalyticsReportCreateRequest": { "additionalProperties": false, "properties": { "compare_previous": { "default": true, "type": "boolean" }, "from": { "format": "date", "type": "string" }, "group_by": { "items": { "enum": [ "source_type", "source", "message", "provider", "day" ], "type": "string" }, "maxItems": 2, "type": "array" }, "source_ids": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "source_types": { "items": { "enum": [ "broadcast", "sequence", "automation" ], "type": "string" }, "maxItems": 3, "type": "array" }, "to": { "format": "date", "type": "string" } }, "required": [ "from", "to" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/AnalyticsReportCreateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "AnalyticsReport": { "additionalProperties": true, "description": "A 24-hour cached report with at most 100 aggregate rows, explicit definitions, freshness, attribution, and optional previous-period comparison.", "properties": { "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" } }, "required": [ "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createAnalyticsReport", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "anyOf": [ { "properties": { "data": { "$ref": "#/$defs/AnalyticsReport" } }, "required": [ "data" ], "type": "object" }, { "properties": { "data": { "$ref": "#/$defs/AnalyticsReport" } }, "required": [ "data" ], "type": "object" } ] } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create or reuse an analytics report" } }, { "name": "analytics_get_report", "title": "Get an analytics report", "description": "Returns one unexpired bounded analytics report by identifier. Permission: analytics:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum aggregate row count, from 1 to 50.", "maximum": 50, "minimum": 1, "type": "integer" }, "report_id": { "description": "Stable analytics report identifier.", "type": "string" }, "starting_after": { "description": "Opaque next_cursor returned by the previous report page.", "type": "string" } }, "required": [ "report_id" ], "type": "object" }, "outputSchema": { "$defs": { "AnalyticsReport": { "additionalProperties": true, "description": "A 24-hour cached report with at most 100 aggregate rows, explicit definitions, freshness, attribution, and optional previous-period comparison.", "properties": { "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" } }, "required": [ "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getAnalyticsReport", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/AnalyticsReport" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get an analytics report" } }, { "name": "subscribers_list", "title": "List subscribers", "description": "Returns subscribers in the authenticated workspace, sorted from newest to oldest. Permission: subscribers:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "cold_only": { "description": "When `true`, return only cold subscribers.", "type": "boolean" }, "email": { "description": "Filter subscribers by an exact subscriber email address.", "format": "email", "type": "string" }, "limit": { "description": "Maximum number of subscribers to return. Defaults to 25 and is capped at 100.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter subscribers by name, email, or status.", "type": "string" }, "sequence_id": { "description": "Return subscribers that match this sequence ID. Repeat `sequence_id` or use `sequence_ids` to match any of several sequences.", "type": "string" }, "sequence_ids": { "description": "Comma-separated sequence IDs. By default, the API returns only subscribers who are active in any listed sequence.", "type": "string" }, "sequence_operator": { "default": "is_active_in_any_of", "description": "Controls how sequence filters are applied. Defaults to `is_active_in_any_of`.", "enum": [ "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of" ], "type": "string" }, "starting_after": { "description": "Use the opaque cursor from the previous page to request the next page.", "type": "string" }, "status": { "description": "Filter subscribers by subscriber status.", "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "tag_id": { "description": "Return subscribers that currently have this tag ID. Repeat `tag_id` or use `tag_ids` to match any of several tags.", "type": "string" }, "tag_ids": { "description": "Comma-separated tag IDs. By default, the API returns subscribers who have any listed tag.", "type": "string" }, "tag_operator": { "default": "has_any_of", "description": "Controls how tag filters are applied. Defaults to `has_any_of`.", "enum": [ "has_any_of", "has_none_of" ], "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listSubscribers", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/Subscriber" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List subscribers" } }, { "name": "subscribers_get", "title": "Get a subscriber", "description": "Returns one Subscriber by its stable identifier from the authenticated workspace. Permission: subscribers:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "subscriber_id": { "description": "The Subscriber identifier.", "type": "string" } }, "required": [ "subscriber_id" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getSubscriber", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a subscriber" } }, { "name": "subscribers_upsert", "title": "Create or upsert a subscriber", "description": "Creates a new subscriber when the email does not exist in the workspace. If the email already exists, the API updates the existing subscriber unless create_only is true. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "ConsentEvidence": { "additionalProperties": false, "description": "Compact evidence required when the public API makes a Subscriber Active. Keep raw consent text, IP addresses, and user-agent data in your evidence system; Mailrith stores only this version, reference, URL, and optional SHA-256 digest.", "properties": { "collected_at": { "description": "When the consent evidence was collected, as ISO 8601 with an explicit UTC offset. This must not be later than Mailrith's server time. Do not treat a workspace-local clock as UTC; use the evidence record's confirmed timestamp.", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$", "type": "string" }, "consent_text_version": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ] }, "evidence_reference": { "maxLength": 512, "type": "string" }, "lawful_basis": { "maxLength": 64, "type": "string" }, "source_url": { "anyOf": [ { "format": "uri", "maxLength": 2048, "type": "string" }, { "type": "null" } ] }, "technical_evidence_hash": { "anyOf": [ { "pattern": "^[a-f0-9]{64}$", "type": "string" }, { "type": "null" } ] } }, "required": [ "lawful_basis", "collected_at", "evidence_reference" ], "type": "object" }, "SubscriberUpsertRequest": { "example": { "country": "DE", "custom_fields": { "cf_company": "Analytical Engines" }, "email": "ada@example.com", "name": "Ada Lovelace", "status": "Unconfirmed" }, "examples": [ { "country": "DE", "custom_fields": { "cf_company": "Analytical Engines" }, "email": "ada@example.com", "name": "Ada Lovelace", "status": "Unconfirmed" } ], "properties": { "consent_evidence": { "$ref": "#/$defs/ConsentEvidence" }, "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "create_only": { "description": "When true, Mailrith returns a 409 conflict instead of updating an existing subscriber with the same email.", "type": "boolean" }, "custom_fields": { "additionalProperties": true, "description": "Custom field values keyed by custom field ID. For Multi Select fields, send an array of option names or a comma-separated string. Blank optional values leave saved values unchanged when updating an existing subscriber, and filled-in invalid values are rejected.", "type": "object" }, "email": { "format": "email", "type": "string" }, "name": { "type": "string" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_on": { "description": "Subscriber-local subscription date in YYYY-MM-DD format.", "example": "2026-04-11", "examples": [ "2026-04-11" ], "type": "string" } }, "required": [ "email" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SubscriberUpsertRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "upsertSubscriber", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "anyOf": [ { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" }, { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } ] } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Create or upsert a subscriber" } }, { "name": "subscribers_update", "title": "Update a subscriber", "description": "Updates profile fields, status, custom fields, tags, or sequence assignments for one subscriber. Fields omitted from the request stay unchanged. Blank optional custom field values also leave saved values unchanged, and filled-in invalid values are rejected. Effect: subscriber-change. Retry after reading the current resource state. Permission: subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "SubscriberUpdateRequest": { "example": { "country": "DE", "custom_fields": { "cf_company": "Analytical Engines" }, "name": "Ada Lovelace" }, "examples": [ { "country": "DE", "custom_fields": { "cf_company": "Analytical Engines" }, "name": "Ada Lovelace" } ], "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "custom_fields": { "additionalProperties": true, "description": "Custom field values keyed by custom field ID. For Multi Select fields, send an array of option names or a comma-separated string. Blank optional values leave saved values unchanged, and filled-in invalid values are rejected.", "type": "object" }, "email": { "format": "email", "type": "string" }, "name": { "type": "string" }, "subscribed_on": { "description": "Subscriber-local subscription date in YYYY-MM-DD format.", "example": "2026-04-11", "examples": [ "2026-04-11" ], "type": "string" } }, "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SubscriberUpdateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "subscriber_id": { "description": "The subscriber identifier.", "type": "string" } }, "required": [ "subscriber_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateSubscriber", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Update a subscriber" } }, { "name": "subscribers_update_status", "title": "Change Subscriber sending eligibility", "description": "Changes the delivery status for one Subscriber without changing profile, targeting, or Sequence enrollment fields. Making a Subscriber Active requires consent_evidence; its collected_at value must include the correct UTC offset and must not be later than Mailrith's server time. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "ConsentEvidence": { "additionalProperties": false, "description": "Compact evidence required when the public API makes a Subscriber Active. Keep raw consent text, IP addresses, and user-agent data in your evidence system; Mailrith stores only this version, reference, URL, and optional SHA-256 digest.", "properties": { "collected_at": { "description": "When the consent evidence was collected, as ISO 8601 with an explicit UTC offset. This must not be later than Mailrith's server time. Do not treat a workspace-local clock as UTC; use the evidence record's confirmed timestamp.", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$", "type": "string" }, "consent_text_version": { "anyOf": [ { "maxLength": 128, "type": "string" }, { "type": "null" } ] }, "evidence_reference": { "maxLength": 512, "type": "string" }, "lawful_basis": { "maxLength": 64, "type": "string" }, "source_url": { "anyOf": [ { "format": "uri", "maxLength": 2048, "type": "string" }, { "type": "null" } ] }, "technical_evidence_hash": { "anyOf": [ { "pattern": "^[a-f0-9]{64}$", "type": "string" }, { "type": "null" } ] } }, "required": [ "lawful_basis", "collected_at", "evidence_reference" ], "type": "object" }, "SubscriberStatusRequest": { "properties": { "consent_evidence": { "$ref": "#/$defs/ConsentEvidence" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" } }, "required": [ "status" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SubscriberStatusRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "subscriber_id": { "description": "The Subscriber identifier.", "type": "string" } }, "required": [ "subscriber_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateSubscriberStatus", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Change Subscriber sending eligibility" } }, { "name": "subscribers_add_tag", "title": "Add a Tag to a Subscriber", "description": "Adds the selected Tag to a Subscriber. If the Subscriber already has the Tag, the API returns the Subscriber unchanged. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "subscriber_id": { "description": "The Subscriber identifier.", "type": "string" }, "tag_id": { "description": "The Tag identifier.", "type": "string" } }, "required": [ "subscriber_id", "tag_id" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "addSubscriberTag", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Add a Tag to a Subscriber" } }, { "name": "subscribers_remove_tag", "title": "Remove a tag from a subscriber", "description": "Removes the selected tag from a subscriber. If the subscriber does not have the tag, the API returns the subscriber unchanged. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "subscriber_id": { "description": "The subscriber identifier.", "type": "string" }, "tag_id": { "description": "The tag identifier.", "type": "string" } }, "required": [ "subscriber_id", "tag_id" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "removeSubscriberTag", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Remove a tag from a subscriber" } }, { "name": "subscribers_add_to_sequence", "title": "Add a subscriber to a sequence", "description": "Adds the selected subscriber to the selected sequence. If the subscriber is already in the sequence, the API returns the subscriber unchanged. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sequence_id": { "description": "The sequence identifier.", "type": "string" }, "subscriber_id": { "description": "The subscriber identifier.", "type": "string" } }, "required": [ "subscriber_id", "sequence_id" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "addSubscriberSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Add a subscriber to a sequence" } }, { "name": "subscribers_remove_from_sequence", "title": "Remove a subscriber from a sequence", "description": "Removes the selected subscriber from the selected sequence. If the subscriber is not in the sequence, the API returns the subscriber unchanged. Effect: subscriber-change. Retry after reading the current resource state. Permissions: live_actions:write, subscribers:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sequence_id": { "description": "The sequence identifier.", "type": "string" }, "subscriber_id": { "description": "The subscriber identifier.", "type": "string" } }, "required": [ "subscriber_id", "sequence_id" ], "type": "object" }, "outputSchema": { "$defs": { "Subscriber": { "properties": { "country": { "anyOf": [ { "description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code.", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "custom_fields": { "additionalProperties": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "id": { "type": "string" }, "last_opened_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "sequence_ids": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "subscribed_at": { "format": "date-time", "type": "string" }, "tags": { "items": { "$ref": "#/$defs/TagSummary" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "email", "name", "status", "country", "subscribed_at", "tags", "sequence_ids", "custom_fields", "created_at", "updated_at", "self" ], "type": "object" }, "TagSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "removeSubscriberSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Subscriber" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Remove a subscriber from a sequence" } }, { "name": "tags_list", "title": "List tags", "description": "Returns tags in the authenticated workspace. Permission: tags:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of tags to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter Tags by name or description. Retrieve a known Tag ID through the item endpoint.", "type": "string" }, "starting_after": { "description": "Use the opaque cursor from the previous page to request the next page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "Tag": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gdpr_consent_purpose": { "anyOf": [ { "description": "Read-only GDPR consent purpose for Mailrith consent tags. Null for ordinary tags.", "enum": [ "email_marketing", "ads_personalization" ], "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "gdpr_consent_purpose", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listTags", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List tags" } }, { "name": "tags_get", "title": "Get a tag", "description": "Returns one Tag from the authenticated workspace. Permission: tags:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "tag_id": { "description": "The Tag identifier.", "type": "string" } }, "required": [ "tag_id" ], "type": "object" }, "outputSchema": { "$defs": { "Tag": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gdpr_consent_purpose": { "anyOf": [ { "description": "Read-only GDPR consent purpose for Mailrith consent tags. Null for ordinary tags.", "enum": [ "email_marketing", "ads_personalization" ], "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "gdpr_consent_purpose", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getTag", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Tag" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a tag" } }, { "name": "tags_create", "title": "Create a tag", "description": "Creates a new tag in the authenticated workspace. The GDPR consent tag names can be created and applied like other tags when you need to apply consent collected outside Mailrith. Tag-level double opt-in fields are no longer accepted; configure double opt-in on forms and landing pages instead. Effect: workspace-change. Retry with the same idempotency_key. Permission: tags:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "TagCreateRequest": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "description": "Tag name to create. You can also create the GDPR consent tag names when you need to apply consent collected outside Mailrith.", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/TagCreateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "Tag": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gdpr_consent_purpose": { "anyOf": [ { "description": "Read-only GDPR consent purpose for Mailrith consent tags. Null for ordinary tags.", "enum": [ "email_marketing", "ads_personalization" ], "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "gdpr_consent_purpose", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createTag", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Tag" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create a tag" } }, { "name": "custom_fields_list", "title": "List custom fields", "description": "Returns a bounded page of custom fields in the authenticated workspace, including each field's exact ready-to-use email personalization token. Permission: custom_fields:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of custom fields to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter custom fields by label or type.", "maxLength": 200, "type": "string" }, "starting_after": { "description": "Use the opaque cursor from the previous page to request the next page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "CustomField": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "personalization_token": { "description": "The exact ready-to-use token for this custom field. Copy it into an email subject or body text node and replace only the fallback text when needed. This value is computed from the current field label and is not stored separately.", "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "settings": { "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "required": [ "options" ], "type": "object" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "label", "type", "settings", "personalization_token", "created_at", "updated_at", "self" ], "type": "object" }, "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listCustomFields", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/CustomField" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List custom fields" } }, { "name": "custom_fields_get", "title": "Get a custom field", "description": "Returns one custom field from the authenticated workspace, including its exact ready-to-use email personalization token. Permission: custom_fields:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "custom_field_id": { "description": "The custom field identifier.", "type": "string" } }, "required": [ "custom_field_id" ], "type": "object" }, "outputSchema": { "$defs": { "CustomField": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "personalization_token": { "description": "The exact ready-to-use token for this custom field. Copy it into an email subject or body text node and replace only the fallback text when needed. This value is computed from the current field label and is not stored separately.", "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "settings": { "properties": { "options": { "items": { "type": "string" }, "type": "array" } }, "required": [ "options" ], "type": "object" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "label", "type", "settings", "personalization_token", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getCustomField", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/CustomField" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a custom field" } }, { "name": "segments_list", "title": "List segments", "description": "Returns saved segments from the authenticated workspace. Permission: segments:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "The maximum number of segments to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter Segments by name or description.", "maxLength": 200, "type": "string" }, "starting_after": { "description": "The opaque cursor from the previous page of saved segments.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "SegmentSummary": { "additionalProperties": false, "properties": { "confirmed_subscriber_count": { "minimum": 0, "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "total_subscriber_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "confirmed_subscriber_count", "total_subscriber_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listSegments", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/SegmentSummary" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List segments" } }, { "name": "segments_get", "title": "Get a segment", "description": "Returns one saved segment from the authenticated workspace. Permission: segments:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "segment_id": { "description": "The identifier of the segment to return.", "type": "string" } }, "required": [ "segment_id" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Segment": { "properties": { "confirmed_subscriber_count": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/AudienceDefinition" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "total_subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "definition", "confirmed_subscriber_count", "total_subscriber_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getSegment", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Segment" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a segment" } }, { "name": "segments_preview", "title": "Preview a segment definition", "description": "Returns subscriber counts for an unsaved segment definition. Include `current_segment_id` when previewing edits to an existing segment so circular segment references are rejected before saving. Permission: segments:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "SegmentPreviewRequest": { "properties": { "current_segment_id": { "anyOf": [ { "description": "When previewing an edit to an existing segment, include that segment id so Mailrith can catch circular segment references before saving.", "type": "string" }, { "type": "null" } ] }, "definition": { "allOf": [ { "$ref": "#/$defs/AudienceDefinition" } ], "description": "The segment filters to preview. Include at least one filter group." } }, "required": [ "definition" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SegmentPreviewRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "SegmentPreview": { "properties": { "confirmed_subscriber_count": { "type": "integer" }, "total_subscriber_count": { "type": "integer" } }, "required": [ "confirmed_subscriber_count", "total_subscriber_count" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "previewSegment", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/SegmentPreview" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Preview a segment definition" } }, { "name": "broadcasts_list", "title": "List broadcasts", "description": "Returns broadcast drafts, scheduled sends, active sends, and completed sends. Permission: broadcasts:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of items to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter Broadcasts by subject, preview text, status, or sender.", "maxLength": 200, "type": "string" }, "starting_after": { "description": "Opaque cursor returned by the previous page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "BroadcastSummary": { "additionalProperties": false, "properties": { "bounced_count": { "minimum": 0, "type": "integer" }, "clicked_count": { "minimum": 0, "type": "integer" }, "complained_count": { "minimum": 0, "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "opened_count": { "minimum": 0, "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "minimum": 0, "type": "integer" }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "unsubscribed_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "subject", "preview_text", "status", "scheduled_at", "completed_at", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listBroadcasts", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/BroadcastSummary" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List broadcasts" } }, { "name": "broadcasts_create", "title": "Create a broadcast", "description": "Creates a broadcast draft in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastUpsertRequest": { "additionalProperties": false, "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "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." }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subject": { "description": "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.", "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "subject", "body_document" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/BroadcastUpsertRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Broadcast" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create a broadcast" } }, { "name": "broadcasts_get", "title": "Get a broadcast", "description": "Returns a broadcast draft, scheduled send, active send, or completed send. Permission: broadcasts:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Broadcast" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a broadcast" } }, { "name": "broadcasts_update", "title": "Update a broadcast", "description": "Updates an existing Broadcast draft. Scheduled, running, completed, and failed Broadcasts cannot be changed here. Before changing a scheduled Broadcast, read it by ID and retain its scheduled_at in the current task only. If the saved time is no longer safely in the future, ask the user for a new time before unscheduling. Otherwise unschedule it, apply the update, reschedule it for the same time, and verify both status and scheduled_at. If the update fails after unscheduling, restore the unchanged Broadcast to the same future time when possible. If the schedule cannot be restored, leave it as a Draft and immediately report that it will not send; never choose a replacement time without the user. Effect: workspace-change. Retry after reading the current resource state. Permission: broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastUpdateRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "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." }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subject": { "description": "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.", "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/BroadcastUpdateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Broadcast" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Update a broadcast" } }, { "name": "broadcasts_preflight", "title": "Inspect broadcast readiness", "description": "Optionally checks the current Subscriber estimate, provider capacity, sender setup, event tracking, and blocking issues. This diagnostic is not required before starting a durable send. Permission: broadcasts:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastSendPreflight": { "description": "Current Subscriber estimate, provider capacity, sender and event setup health, duration estimate, and blocking issues.", "properties": { "blocking_issues": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "resolution": { "type": "string" } }, "required": [ "code", "message", "resolution" ], "type": "object" }, "type": "array" }, "broadcast_id": { "type": "string" }, "checked_at": { "format": "date-time", "type": "string" }, "connection": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": [ "id", "name", "provider" ], "type": "object" }, "estimated_duration_seconds": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "event_webhook_health": { "enum": [ "healthy", "unknown" ], "type": "string" }, "provider_production_status": { "enum": [ "production", "restricted", "unknown" ], "type": "string" }, "recipient_estimate": { "minimum": 0, "type": "integer" }, "remaining_daily_quota": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ] }, "safe_send_rate": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ] }, "send_proof": { "anyOf": [ { "description": "Short-lived proof returned when preflight passes. Submit it unchanged to Send so Mailrith can accept the durable run without repeating the expensive Subscriber count and provider checks.", "type": "string" }, { "type": "null" } ] }, "send_proof_expires_at": { "anyOf": [ { "description": "When the short-lived Send proof expires. Run preflight again after this time.", "format": "date-time", "type": "string" }, { "type": "null" } ] }, "sender_authentication_status": { "enum": [ "verified", "unverified", "unknown" ], "type": "string" }, "sending_quota": { "anyOf": [ { "properties": { "limit": { "minimum": 1, "type": "integer" }, "period": { "enum": [ "rolling-24-hours", "day", "month" ], "type": "string" }, "remaining": { "minimum": 0, "type": "integer" } }, "required": [ "remaining", "limit", "period" ], "type": "object" }, { "type": "null" } ] }, "subject": { "type": "string" }, "workspace_id": { "type": "string" } }, "required": [ "workspace_id", "broadcast_id", "subject", "recipient_estimate", "connection", "provider_production_status", "remaining_daily_quota", "sending_quota", "safe_send_rate", "estimated_duration_seconds", "sender_authentication_status", "event_webhook_health", "blocking_issues", "checked_at", "send_proof", "send_proof_expires_at" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "preflightBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/BroadcastSendPreflight" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Inspect broadcast readiness" } }, { "name": "broadcasts_send_test", "title": "Send a broadcast test email", "description": "Sends a test message from an existing Broadcast that has an email delivery connection. Provide a saved Subscriber ID for personalization; use subscribers_list to find one when needed. The recipient may be any test inbox and does not have to match the saved Subscriber. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, subscribers:read, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "BroadcastTestRequest": { "additionalProperties": false, "properties": { "recipient": { "description": "The inbox that receives the test message. It may differ from the saved Subscriber used for personalization.", "format": "email", "type": "string" }, "subscriber_id": { "description": "Required saved Subscriber ID whose profile supplies personalization. Use subscribers_list to find one before sending the test when needed.", "type": "string" } }, "required": [ "recipient", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/BroadcastTestRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "broadcast_id": { "description": "The broadcast identifier.", "type": "string" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "broadcast_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastTestResult": { "additionalProperties": false, "properties": { "provider_message_ids": { "description": "Provider acceptance IDs in sent-message order; null when unavailable. These are not delivery or inbox receipts.", "items": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ] }, "maxItems": 5, "minItems": 1, "type": "array" }, "status": { "enum": [ "completed" ], "type": "string" }, "subscriber_id": { "type": "string" } }, "required": [ "status", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "testBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/BroadcastTestResult" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Send a broadcast test email" } }, { "name": "broadcasts_schedule", "title": "Schedule or reschedule a broadcast", "description": "Schedules a draft for future delivery, or changes the delivery time of an existing scheduled Broadcast. This uses Mailrith's durable scheduled-send path and does not start delivery immediately. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "BroadcastScheduleRequest": { "additionalProperties": false, "example": { "scheduled_at": "2026-08-01T09:30:00.000Z" }, "examples": [ { "scheduled_at": "2026-08-01T09:30:00.000Z" } ], "properties": { "scheduled_at": { "description": "A future date and time. Include an explicit UTC offset or Z suffix.", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$", "type": "string" } }, "required": [ "scheduled_at" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/BroadcastScheduleRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "scheduleBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Broadcast" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Schedule or reschedule a broadcast" } }, { "name": "broadcasts_unschedule", "title": "Unschedule a broadcast", "description": "Returns a scheduled Broadcast to draft state before delivery starts. Effect: workspace-change. Retry after reading the current resource state. Permissions: live_actions:write, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "unscheduleBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Broadcast" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Unschedule a broadcast" } }, { "name": "broadcasts_send", "title": "Send a broadcast now", "description": "Immediately creates durable preparation for a broadcast draft or scheduled send. Mailrith calculates the exact Subscriber total and checks provider readiness in the background before delivery. A 202 response means the durable send was accepted, not that provider delivery is complete. Reuse the same idempotency key if the response is lost. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "body": { "description": "The exact JSON request body defined by the Mailrith public API contract.", "properties": { "preflight_proof": { "description": "Optional unchanged short-lived send_proof returned by a recent diagnostic preflight. A valid proof can seed its checked estimate. If it is omitted, expired, or no longer matches, Mailrith still creates the run immediately and calculates the exact total during durable preparation.", "type": "string" } }, "type": "object" }, "broadcast_id": { "description": "The broadcast identifier.", "type": "string" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "Broadcast": { "properties": { "audience_definition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "body": { "type": "string" }, "body_document": { "$ref": "#/$defs/BroadcastEmailDocument" }, "bounced_count": { "type": "integer" }, "clicked_count": { "type": "integer" }, "complained_count": { "type": "integer" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "opened_count": { "type": "integer" }, "preview_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient_count": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "running", "completed", "failed" ], "type": "string" }, "subject": { "type": "string" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "subject", "preview_text", "body", "body_document", "status", "scheduled_at", "completed_at", "connection_id", "from_name", "from_email", "reply_to_email", "audience_definition", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "recipient_count", "opened_count", "clicked_count", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "sendBroadcast", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "properties": { "resource": { "$ref": "#/$defs/Broadcast" }, "run_id": { "type": "string" }, "status": { "description": "Queued means Mailrith accepted the send and will start it automatically when a sending slot is available.", "enum": [ "running", "queued" ], "type": "string" } }, "required": [ "status", "run_id", "resource" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Send a broadcast now" } }, { "name": "broadcasts_cancel", "title": "Cancel a broadcast send", "description": "Requests cancellation for delivery work that has not reached the provider. Provider-accepted emails cannot be recalled. Repeat the same request with the same idempotency key when the response is lost. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, broadcasts:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "broadcast_id": { "description": "The broadcast identifier.", "type": "string" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "cancelBroadcastSend", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "properties": { "changed": { "type": "boolean" }, "message": { "type": "string" }, "recovery_pending": { "type": "boolean" }, "run_id": { "type": "string" }, "status": { "description": "canceling while remaining work is stopping, or canceled when cancellation already finished.", "enum": [ "canceling", "canceled" ], "type": "string" } }, "required": [ "status", "run_id", "changed", "recovery_pending", "message" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Cancel a broadcast send" } }, { "name": "broadcasts_get_send_progress", "title": "Get broadcast send progress", "description": "Returns bounded delivery progress, current rates, timing, outcome counts, and pause state. Poll until terminal is true; use 5 to 10 second intervals while progress changes and back off to 30 seconds when unchanged. Permission: broadcasts:read. Polling: wait at least 2 seconds, use exponential backoff up to 30 seconds, stop at a terminal state, and stop after 15 minutes. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "broadcast_id": { "description": "The broadcast identifier.", "type": "string" } }, "required": [ "broadcast_id" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastSendProgress": { "properties": { "accepted": { "type": "integer" }, "canceled": { "type": "integer" }, "effective_rate": { "type": "number" }, "estimated_completion": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "estimated_completion_basis": { "anyOf": [ { "description": "Whether the estimate uses only the current rate or also includes known provider quota windows.", "enum": [ "current-rate", "provider-quota" ], "type": "string" }, { "type": "null" } ] }, "last_progress_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "materialized": { "type": "integer" }, "next_retry_action": { "anyOf": [ { "description": "Whether the next time is a known quota reset or another connection check.", "enum": [ "resume", "recheck" ], "type": "string" }, { "type": "null" } ] }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "pause_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_complete": { "type": "number" }, "permanent_failed": { "type": "integer" }, "phase": { "enum": [ "preparing", "sending", "paused", "canceling", "sent", "sent_with_errors", "canceled", "failed" ], "type": "string" }, "provider": { "anyOf": [ { "description": "The email delivery provider used by this send.", "type": "string" }, { "type": "null" } ] }, "provider_limited_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "retrying": { "type": "integer" }, "run_id": { "type": "string" }, "selected": { "type": "integer" }, "sent": { "type": "integer" }, "skipped": { "type": "integer" }, "terminal": { "type": "boolean" }, "unknown": { "type": "integer" } }, "required": [ "run_id", "phase", "selected", "materialized", "sent", "accepted", "skipped", "retrying", "permanent_failed", "unknown", "canceled", "percent_complete", "effective_rate", "provider_limited_rate", "provider", "estimated_completion", "estimated_completion_basis", "last_progress_at", "pause_reason", "next_retry_at", "next_retry_action", "pause_message", "terminal" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getBroadcastSendProgress", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/BroadcastSendProgress" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get broadcast send progress" } }, { "name": "sequences_list", "title": "List sequences", "description": "Returns sequences in the authenticated workspace. Permission: sequences:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of sequences to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter sequences by name, status, or sender details. Retrieve a known Sequence ID through the item endpoint.", "type": "string" }, "starting_after": { "description": "Use the opaque cursor from the previous page to request the next page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "SequenceSummary": { "additionalProperties": false, "properties": { "click_rate": { "minimum": 0, "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "email_count": { "minimum": 0, "type": "integer" }, "id": { "type": "string" }, "is_updating": { "type": "boolean" }, "name": { "type": "string" }, "open_rate": { "minimum": 0, "type": "integer" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "running", "paused" ], "type": "string" }, "subscriber_count": { "minimum": 0, "type": "integer" }, "unsubscribed_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "email_count", "subscriber_count", "open_rate", "click_rate", "unsubscribed_count", "created_at", "updated_at", "self" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listSequences", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/SequenceSummary" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List sequences" } }, { "name": "sequences_create", "title": "Create a sequence", "description": "Creates a sequence in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: sequences:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" }, "SequenceUpsertRequest": { "additionalProperties": false, "properties": { "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "name": { "type": "string" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "definition" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SequenceUpsertRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastSendProgress": { "properties": { "accepted": { "type": "integer" }, "canceled": { "type": "integer" }, "effective_rate": { "type": "number" }, "estimated_completion": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "estimated_completion_basis": { "anyOf": [ { "description": "Whether the estimate uses only the current rate or also includes known provider quota windows.", "enum": [ "current-rate", "provider-quota" ], "type": "string" }, { "type": "null" } ] }, "last_progress_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "materialized": { "type": "integer" }, "next_retry_action": { "anyOf": [ { "description": "Whether the next time is a known quota reset or another connection check.", "enum": [ "resume", "recheck" ], "type": "string" }, { "type": "null" } ] }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "pause_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_complete": { "type": "number" }, "permanent_failed": { "type": "integer" }, "phase": { "enum": [ "preparing", "sending", "paused", "canceling", "sent", "sent_with_errors", "canceled", "failed" ], "type": "string" }, "provider": { "anyOf": [ { "description": "The email delivery provider used by this send.", "type": "string" }, { "type": "null" } ] }, "provider_limited_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "retrying": { "type": "integer" }, "run_id": { "type": "string" }, "selected": { "type": "integer" }, "sent": { "type": "integer" }, "skipped": { "type": "integer" }, "terminal": { "type": "boolean" }, "unknown": { "type": "integer" } }, "required": [ "run_id", "phase", "selected", "materialized", "sent", "accepted", "skipped", "retrying", "permanent_failed", "unknown", "canceled", "percent_complete", "effective_rate", "provider_limited_rate", "provider", "estimated_completion", "estimated_completion_basis", "last_progress_at", "pause_reason", "next_retry_at", "next_retry_action", "pause_message", "terminal" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "Sequence": { "properties": { "bounced_count": { "type": "integer" }, "click_rate": { "type": "integer" }, "complained_count": { "type": "integer" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Sequence change.", "type": "boolean" }, "name": { "type": "string" }, "open_rate": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "send_progress": { "anyOf": [ { "allOf": [ { "$ref": "#/$defs/BroadcastSendProgress" } ] }, { "type": "null" } ] }, "status": { "enum": [ "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "is_updating", "connection_id", "from_name", "from_email", "reply_to_email", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "definition", "subscriber_count", "open_rate", "click_rate", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "body": { "description": "Rendered HTML returned by Mailrith. Agents should send bodyDocument when creating or updating a Sequence.", "readOnly": true, "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Sequence" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create a sequence" } }, { "name": "sequences_get", "title": "Get a sequence", "description": "Returns one sequence from the authenticated workspace. Permission: sequences:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sequence_id": { "description": "The sequence identifier.", "type": "string" } }, "required": [ "sequence_id" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastSendProgress": { "properties": { "accepted": { "type": "integer" }, "canceled": { "type": "integer" }, "effective_rate": { "type": "number" }, "estimated_completion": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "estimated_completion_basis": { "anyOf": [ { "description": "Whether the estimate uses only the current rate or also includes known provider quota windows.", "enum": [ "current-rate", "provider-quota" ], "type": "string" }, { "type": "null" } ] }, "last_progress_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "materialized": { "type": "integer" }, "next_retry_action": { "anyOf": [ { "description": "Whether the next time is a known quota reset or another connection check.", "enum": [ "resume", "recheck" ], "type": "string" }, { "type": "null" } ] }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "pause_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_complete": { "type": "number" }, "permanent_failed": { "type": "integer" }, "phase": { "enum": [ "preparing", "sending", "paused", "canceling", "sent", "sent_with_errors", "canceled", "failed" ], "type": "string" }, "provider": { "anyOf": [ { "description": "The email delivery provider used by this send.", "type": "string" }, { "type": "null" } ] }, "provider_limited_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "retrying": { "type": "integer" }, "run_id": { "type": "string" }, "selected": { "type": "integer" }, "sent": { "type": "integer" }, "skipped": { "type": "integer" }, "terminal": { "type": "boolean" }, "unknown": { "type": "integer" } }, "required": [ "run_id", "phase", "selected", "materialized", "sent", "accepted", "skipped", "retrying", "permanent_failed", "unknown", "canceled", "percent_complete", "effective_rate", "provider_limited_rate", "provider", "estimated_completion", "estimated_completion_basis", "last_progress_at", "pause_reason", "next_retry_at", "next_retry_action", "pause_message", "terminal" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "Sequence": { "properties": { "bounced_count": { "type": "integer" }, "click_rate": { "type": "integer" }, "complained_count": { "type": "integer" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Sequence change.", "type": "boolean" }, "name": { "type": "string" }, "open_rate": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "send_progress": { "anyOf": [ { "allOf": [ { "$ref": "#/$defs/BroadcastSendProgress" } ] }, { "type": "null" } ] }, "status": { "enum": [ "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "is_updating", "connection_id", "from_name", "from_email", "reply_to_email", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "definition", "subscriber_count", "open_rate", "click_rate", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "body": { "description": "Rendered HTML returned by Mailrith. Agents should send bodyDocument when creating or updating a Sequence.", "readOnly": true, "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Sequence" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get a sequence" } }, { "name": "sequences_update", "title": "Update a sequence", "description": "Updates an existing paused Sequence. Before changing a running Sequence, 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 Sequence, 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 a Sequence that was not already running. Effect: workspace-change. Retry after reading the current resource state. Permission: sequences:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" }, "SequenceUpdateRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "name": { "type": "string" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SequenceUpdateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "sequence_id": { "description": "The sequence identifier.", "type": "string" } }, "required": [ "sequence_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastSendProgress": { "properties": { "accepted": { "type": "integer" }, "canceled": { "type": "integer" }, "effective_rate": { "type": "number" }, "estimated_completion": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "estimated_completion_basis": { "anyOf": [ { "description": "Whether the estimate uses only the current rate or also includes known provider quota windows.", "enum": [ "current-rate", "provider-quota" ], "type": "string" }, { "type": "null" } ] }, "last_progress_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "materialized": { "type": "integer" }, "next_retry_action": { "anyOf": [ { "description": "Whether the next time is a known quota reset or another connection check.", "enum": [ "resume", "recheck" ], "type": "string" }, { "type": "null" } ] }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "pause_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_complete": { "type": "number" }, "permanent_failed": { "type": "integer" }, "phase": { "enum": [ "preparing", "sending", "paused", "canceling", "sent", "sent_with_errors", "canceled", "failed" ], "type": "string" }, "provider": { "anyOf": [ { "description": "The email delivery provider used by this send.", "type": "string" }, { "type": "null" } ] }, "provider_limited_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "retrying": { "type": "integer" }, "run_id": { "type": "string" }, "selected": { "type": "integer" }, "sent": { "type": "integer" }, "skipped": { "type": "integer" }, "terminal": { "type": "boolean" }, "unknown": { "type": "integer" } }, "required": [ "run_id", "phase", "selected", "materialized", "sent", "accepted", "skipped", "retrying", "permanent_failed", "unknown", "canceled", "percent_complete", "effective_rate", "provider_limited_rate", "provider", "estimated_completion", "estimated_completion_basis", "last_progress_at", "pause_reason", "next_retry_at", "next_retry_action", "pause_message", "terminal" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "Sequence": { "properties": { "bounced_count": { "type": "integer" }, "click_rate": { "type": "integer" }, "complained_count": { "type": "integer" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Sequence change.", "type": "boolean" }, "name": { "type": "string" }, "open_rate": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "send_progress": { "anyOf": [ { "allOf": [ { "$ref": "#/$defs/BroadcastSendProgress" } ] }, { "type": "null" } ] }, "status": { "enum": [ "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "is_updating", "connection_id", "from_name", "from_email", "reply_to_email", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "definition", "subscriber_count", "open_rate", "click_rate", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "body": { "description": "Rendered HTML returned by Mailrith. Agents should send bodyDocument when creating or updating a Sequence.", "readOnly": true, "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Sequence" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Update a sequence" } }, { "name": "sequences_preflight", "title": "Check sequence readiness", "description": "Checks the saved Sequence, its published emails, and its email delivery connection without changing data or sending email. Permission: sequences:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sequence_id": { "description": "The Sequence identifier.", "type": "string" } }, "required": [ "sequence_id" ], "type": "object" }, "outputSchema": { "$defs": { "SequencePreflight": { "additionalProperties": false, "properties": { "checked_at": { "format": "date-time", "type": "string" }, "checks": { "items": { "$ref": "#/$defs/WorkflowReadinessCheck" }, "type": "array" }, "email_count": { "minimum": 0, "type": "integer" }, "published_email_count": { "minimum": 0, "type": "integer" }, "ready": { "type": "boolean" }, "sequence_id": { "type": "string" } }, "required": [ "sequence_id", "ready", "email_count", "published_email_count", "checks", "checked_at" ], "type": "object" }, "WorkflowReadinessCheck": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "message": { "type": "string" }, "status": { "enum": [ "passed", "blocking" ], "type": "string" } }, "required": [ "key", "status", "message" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "preflightSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/SequencePreflight" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Check sequence readiness" } }, { "name": "sequences_preview_journey", "title": "Preview a sequence journey", "description": "Returns the bounded saved email timeline and shows which messages a selected Subscriber is eligible to receive, without enrolling the Subscriber or sending email. Permissions: subscribers:read, sequences:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "sequence_id": { "description": "The Sequence identifier.", "type": "string" }, "subscriber_id": { "description": "The saved Subscriber whose personalization and targeting should be previewed.", "type": "string" } }, "required": [ "sequence_id", "subscriber_id" ], "type": "object" }, "outputSchema": { "$defs": { "SequenceJourneyPreview": { "additionalProperties": false, "properties": { "emails": { "items": { "additionalProperties": false, "properties": { "audience_mode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "delay_unit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delay_value": { "minimum": 0, "type": "integer" }, "eligible": { "type": "boolean" }, "email_id": { "type": "string" }, "position": { "minimum": 1, "type": "integer" }, "send_on_weekdays": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "type": "string" } }, "required": [ "position", "email_id", "subject", "status", "eligible", "delay_value", "delay_unit", "send_on_weekdays", "audience_mode" ], "type": "object" }, "maxItems": 100, "type": "array" }, "sequence_id": { "type": "string" }, "side_effect_free": { "enum": [ true ], "type": "boolean" }, "subscriber_eligible": { "type": "boolean" }, "subscriber_id": { "type": "string" } }, "required": [ "sequence_id", "subscriber_id", "subscriber_eligible", "side_effect_free", "emails" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "previewSequenceJourney", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/SequenceJourneyPreview" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Preview a sequence journey" } }, { "name": "sequences_send_test", "title": "Send sequence test messages", "description": "Sends up to five selected saved Sequence emails to one explicit test address. This does not enroll a Subscriber, start the Sequence, or write delivery activity. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, subscribers:read, sequences:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "WorkflowTestRequest": { "additionalProperties": false, "properties": { "message_ids": { "description": "Optional Sequence email IDs or Automation step IDs. Omit to test the first five available messages.", "items": { "type": "string" }, "maxItems": 5, "type": "array", "uniqueItems": true }, "recipient": { "format": "email", "type": "string" }, "subscriber_id": { "description": "The saved Subscriber whose personalization should be rendered in every test message.", "type": "string" } }, "required": [ "recipient", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/WorkflowTestRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" }, "sequence_id": { "description": "The Sequence identifier.", "type": "string" } }, "required": [ "sequence_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "WorkflowTestResult": { "additionalProperties": false, "properties": { "message_ids": { "items": { "type": "string" }, "maxItems": 5, "type": "array" }, "provider_message_ids": { "description": "Provider acceptance IDs in sent-message order; null when unavailable. These are not delivery or inbox receipts.", "items": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ] }, "maxItems": 5, "minItems": 1, "type": "array" }, "sent_count": { "maximum": 5, "minimum": 1, "type": "integer" }, "status": { "enum": [ "completed" ], "type": "string" }, "subscriber_id": { "type": "string" } }, "required": [ "status", "sent_count", "message_ids", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "testSequence", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/WorkflowTestResult" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Send sequence test messages" } }, { "name": "sequences_update_status", "title": "Activate or pause a sequence", "description": "Starts or pauses one Sequence without changing its content or delivery settings. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, sequences:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "SequenceStatusRequest": { "properties": { "status": { "enum": [ "running", "paused" ], "type": "string" } }, "required": [ "status" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SequenceStatusRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "sequence_id": { "description": "The Sequence identifier.", "type": "string" } }, "required": [ "sequence_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "AudienceCondition": { "additionalProperties": false, "properties": { "customFieldId": { "type": [ "string", "null" ] }, "field": { "enum": [ "subscriber_status", "country", "segment", "tag", "sequence", "form", "custom_field", "email_opened", "email_unsubscribed", "magic_link_clicked" ], "type": "string" }, "id": { "type": "string" }, "operator": { "enum": [ "is", "is_not", "has_any_of", "has_none_of", "is_active_in_any_of", "is_not_active_in_any_of", "has_completed_any_of", "has_not_completed_any_of", "has_ever_been_in_any_of", "has_never_been_in_any_of", "contains", "does_not_contain", "is_empty", "is_not_empty", "before", "after", "on", "in_last_days", "greater_than", "less_than", "in_region", "not_in_region" ], "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] } }, "required": [ "id", "field", "operator" ], "type": "object" }, "AudienceConditionGroup": { "additionalProperties": false, "properties": { "conditions": { "items": { "$ref": "#/$defs/AudienceCondition" }, "minItems": 1, "type": "array" }, "id": { "type": "string" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "id", "match", "conditions" ], "type": "object" }, "AudienceDefinition": { "additionalProperties": false, "example": { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" }, "examples": [ { "groups": [ { "conditions": [ { "field": "subscriber_status", "id": "active-status", "operator": "is", "value": [ "Active" ] } ], "id": "active-subscribers", "match": "all" } ], "match": "all" } ], "properties": { "groups": { "items": { "$ref": "#/$defs/AudienceConditionGroup" }, "type": "array" }, "match": { "enum": [ "all", "any" ], "type": "string" } }, "required": [ "match", "groups" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastSendProgress": { "properties": { "accepted": { "type": "integer" }, "canceled": { "type": "integer" }, "effective_rate": { "type": "number" }, "estimated_completion": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "estimated_completion_basis": { "anyOf": [ { "description": "Whether the estimate uses only the current rate or also includes known provider quota windows.", "enum": [ "current-rate", "provider-quota" ], "type": "string" }, { "type": "null" } ] }, "last_progress_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "materialized": { "type": "integer" }, "next_retry_action": { "anyOf": [ { "description": "Whether the next time is a known quota reset or another connection check.", "enum": [ "resume", "recheck" ], "type": "string" }, { "type": "null" } ] }, "next_retry_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "pause_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_complete": { "type": "number" }, "permanent_failed": { "type": "integer" }, "phase": { "enum": [ "preparing", "sending", "paused", "canceling", "sent", "sent_with_errors", "canceled", "failed" ], "type": "string" }, "provider": { "anyOf": [ { "description": "The email delivery provider used by this send.", "type": "string" }, { "type": "null" } ] }, "provider_limited_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "retrying": { "type": "integer" }, "run_id": { "type": "string" }, "selected": { "type": "integer" }, "sent": { "type": "integer" }, "skipped": { "type": "integer" }, "terminal": { "type": "boolean" }, "unknown": { "type": "integer" } }, "required": [ "run_id", "phase", "selected", "materialized", "sent", "accepted", "skipped", "retrying", "permanent_failed", "unknown", "canceled", "percent_complete", "effective_rate", "provider_limited_rate", "provider", "estimated_completion", "estimated_completion_basis", "last_progress_at", "pause_reason", "next_retry_at", "next_retry_action", "pause_message", "terminal" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" }, "Sequence": { "properties": { "bounced_count": { "type": "integer" }, "click_rate": { "type": "integer" }, "complained_count": { "type": "integer" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/SequenceDefinition" }, "from_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Sequence change.", "type": "boolean" }, "name": { "type": "string" }, "open_rate": { "type": "integer" }, "reply_to_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "send_progress": { "anyOf": [ { "allOf": [ { "$ref": "#/$defs/BroadcastSendProgress" } ] }, { "type": "null" } ] }, "status": { "enum": [ "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "track_clicks": { "type": "boolean" }, "track_opens": { "type": "boolean" }, "unsubscribed_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "utm_campaign": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "is_updating", "connection_id", "from_name", "from_email", "reply_to_email", "track_opens", "track_clicks", "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content", "definition", "subscriber_count", "open_rate", "click_rate", "unsubscribed_count", "bounced_count", "complained_count", "created_at", "updated_at", "self" ], "type": "object" }, "SequenceDefinition": { "additionalProperties": false, "example": { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] }, "examples": [ { "emails": [ { "audienceDefinition": null, "audienceMode": "all", "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to the newsletter.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "delayUnit": "day", "delayValue": 0, "id": "welcome", "previewText": "Thanks for joining", "sendOnWeekdays": [ "Mon", "Tue", "Wed", "Thu", "Fri" ], "status": "Published", "subject": "Welcome" } ] } ], "properties": { "defaultTemplateId": { "type": [ "string", "null" ] }, "emails": { "items": { "$ref": "#/$defs/SequenceEmail" }, "type": "array" }, "excludeAudienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "restartSequenceForCompletedSubscribers": { "type": "boolean" }, "sendNewEmailsToCompletedSubscribers": { "type": "boolean" }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "emails" ], "type": "object" }, "SequenceEmail": { "additionalProperties": false, "properties": { "audienceDefinition": { "anyOf": [ { "$ref": "#/$defs/AudienceDefinition" }, { "type": "null" } ] }, "audienceMode": { "enum": [ "all", "include", "exclude" ], "type": "string" }, "body": { "description": "Rendered HTML returned by Mailrith. Agents should send bodyDocument when creating or updating a Sequence.", "readOnly": true, "type": "string" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "delayUnit": { "enum": [ "minute", "hour", "day" ], "type": "string" }, "delayValue": { "minimum": 0, "type": "number" }, "id": { "type": "string" }, "previewText": { "type": [ "string", "null" ] }, "sendOnWeekdays": { "items": { "enum": [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ], "type": "string" }, "type": "array", "uniqueItems": true }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "status": { "enum": [ "Draft", "Published" ], "type": "string" }, "subject": { "description": "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.", "type": "string" } }, "required": [ "id", "subject", "previewText", "bodyDocument", "status", "delayValue", "delayUnit", "sendOnWeekdays" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateSequenceStatus", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Sequence" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Activate or pause a sequence" } }, { "name": "automations_list", "title": "List automations", "description": "Returns automations in the authenticated workspace. Permission: automations:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of automations to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter Automations by name or status.", "maxLength": 200, "type": "string" }, "starting_after": { "description": "Use the opaque cursor from the previous page to request the next page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "AutomationSummary": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "is_updating": { "type": "boolean" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "running", "paused" ], "type": "string" }, "subscriber_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" }, "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listAutomations", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/AutomationSummary" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List automations" } }, { "name": "automations_create", "title": "Create an automation", "description": "Creates an automation in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: automations:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerToken": { "type": "string", "writeOnly": true }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" }, "value": { "description": "A secret header value accepted on writes and never returned.", "type": "string", "writeOnly": true } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "AutomationUpsertRequest": { "additionalProperties": false, "properties": { "definition": { "$ref": "#/$defs/AutomationDefinition" }, "name": { "type": "string" } }, "required": [ "name", "definition" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/AutomationUpsertRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "Automation": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/AutomationDefinition" }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Automation change.", "type": "boolean" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "definition", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" }, "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createAutomation", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Automation" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create an automation" } }, { "name": "automations_get", "title": "Get an automation", "description": "Returns one automation from the authenticated workspace. Permission: automations:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "automation_id": { "description": "The automation identifier.", "type": "string" } }, "required": [ "automation_id" ], "type": "object" }, "outputSchema": { "$defs": { "Automation": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/AutomationDefinition" }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Automation change.", "type": "boolean" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "definition", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" }, "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getAutomation", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Automation" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get an automation" } }, { "name": "automations_update", "title": "Update an automation", "description": "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.", "inputSchema": { "$defs": { "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerToken": { "type": "string", "writeOnly": true }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" }, "value": { "description": "A secret header value accepted on writes and never returned.", "type": "string", "writeOnly": true } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "AutomationUpdateRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "definition": { "$ref": "#/$defs/AutomationDefinition" }, "name": { "type": "string" } }, "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "properties": { "automation_id": { "description": "The automation identifier.", "type": "string" }, "body": { "$ref": "#/$defs/AutomationUpdateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" } }, "required": [ "automation_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "Automation": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/AutomationDefinition" }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Automation change.", "type": "boolean" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "definition", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" }, "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateAutomation", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Automation" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Update an automation" } }, { "name": "automations_preflight", "title": "Check automation readiness", "description": "Checks the saved Automation definition and email delivery prerequisite without running any action. Permission: automations:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "automation_id": { "description": "The Automation identifier.", "type": "string" } }, "required": [ "automation_id" ], "type": "object" }, "outputSchema": { "$defs": { "AutomationPreflight": { "additionalProperties": false, "properties": { "automation_id": { "type": "string" }, "checked_at": { "format": "date-time", "type": "string" }, "checks": { "items": { "$ref": "#/$defs/WorkflowReadinessCheck" }, "type": "array" }, "email_step_count": { "minimum": 0, "type": "integer" }, "ready": { "type": "boolean" }, "step_count": { "minimum": 0, "type": "integer" } }, "required": [ "automation_id", "ready", "step_count", "email_step_count", "checks", "checked_at" ], "type": "object" }, "WorkflowReadinessCheck": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "message": { "type": "string" }, "status": { "enum": [ "passed", "blocking" ], "type": "string" } }, "required": [ "key", "status", "message" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "preflightAutomation", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/AutomationPreflight" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Check automation readiness" } }, { "name": "automations_preview_journey", "title": "Preview an automation journey", "description": "Shows the bounded path a selected Subscriber would take through the current saved conditions without running actions or writing history. Permissions: subscribers:read, automations:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "automation_id": { "description": "The Automation identifier.", "type": "string" }, "subscriber_id": { "description": "The saved Subscriber whose current state should be evaluated.", "type": "string" } }, "required": [ "automation_id", "subscriber_id" ], "type": "object" }, "outputSchema": { "$defs": { "AutomationJourneyPreview": { "additionalProperties": false, "properties": { "automation_id": { "type": "string" }, "cycle_detected": { "type": "boolean" }, "ended": { "type": "boolean" }, "evaluation_basis": { "enum": [ "current_saved_subscriber_state" ], "type": "string" }, "side_effect_free": { "enum": [ true ], "type": "boolean" }, "steps": { "items": { "additionalProperties": false, "properties": { "condition_matched": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "next_step_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "position": { "minimum": 1, "type": "integer" }, "selected_branch": { "anyOf": [ { "enum": [ "yes", "no" ], "type": "string" }, { "type": "null" } ] }, "step_id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "position", "step_id", "kind", "type", "condition_matched", "selected_branch", "next_step_id" ], "type": "object" }, "maxItems": 256, "type": "array" }, "subscriber_id": { "type": "string" }, "triggers": { "items": { "additionalProperties": false, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "automation_id", "subscriber_id", "side_effect_free", "evaluation_basis", "triggers", "ended", "cycle_detected", "steps" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "previewAutomationJourney", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/AutomationJourneyPreview" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Preview an automation journey" } }, { "name": "automations_send_test", "title": "Send automation test messages", "description": "Sends up to five selected saved Automation email steps to one explicit test address. This does not start the Automation or run other actions. Effect: external-email. Retry with the same idempotency_key. Permissions: live_actions:write, subscribers:read, automations:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "WorkflowTestRequest": { "additionalProperties": false, "properties": { "message_ids": { "description": "Optional Sequence email IDs or Automation step IDs. Omit to test the first five available messages.", "items": { "type": "string" }, "maxItems": 5, "type": "array", "uniqueItems": true }, "recipient": { "format": "email", "type": "string" }, "subscriber_id": { "description": "The saved Subscriber whose personalization should be rendered in every test message.", "type": "string" } }, "required": [ "recipient", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "properties": { "automation_id": { "description": "The Automation identifier.", "type": "string" }, "body": { "$ref": "#/$defs/WorkflowTestRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "automation_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "WorkflowTestResult": { "additionalProperties": false, "properties": { "message_ids": { "items": { "type": "string" }, "maxItems": 5, "type": "array" }, "provider_message_ids": { "description": "Provider acceptance IDs in sent-message order; null when unavailable. These are not delivery or inbox receipts.", "items": { "anyOf": [ { "maxLength": 200, "type": "string" }, { "type": "null" } ] }, "maxItems": 5, "minItems": 1, "type": "array" }, "sent_count": { "maximum": 5, "minimum": 1, "type": "integer" }, "status": { "enum": [ "completed" ], "type": "string" }, "subscriber_id": { "type": "string" } }, "required": [ "status", "sent_count", "message_ids", "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "testAutomation", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/WorkflowTestResult" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": false, "openWorldHint": true, "readOnlyHint": false, "title": "Send automation test messages" } }, { "name": "automations_update_status", "title": "Change an automation status", "description": "Starts, pauses, or returns one Automation to draft without changing its definition. Effect: external-email. Retry after reading the current resource state. Permissions: live_actions:write, automations:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "AutomationStatusRequest": { "properties": { "status": { "enum": [ "draft", "running", "paused" ], "type": "string" } }, "required": [ "status" ], "type": "object" } }, "additionalProperties": false, "properties": { "automation_id": { "description": "The Automation identifier.", "type": "string" }, "body": { "$ref": "#/$defs/AutomationStatusRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" } }, "required": [ "automation_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "Automation": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "definition": { "$ref": "#/$defs/AutomationDefinition" }, "id": { "type": "string" }, "is_updating": { "description": "True while Mailrith updates existing Subscriber progress after a structural Automation change.", "type": "boolean" }, "name": { "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "status": { "enum": [ "draft", "running", "paused" ], "type": "string" }, "subscriber_count": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status", "is_updating", "definition", "subscriber_count", "created_at", "updated_at", "self" ], "type": "object" }, "AutomationDefinition": { "additionalProperties": false, "example": { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 }, "examples": [ { "steps": [ { "config": { "bodyDocument": { "content": [ { "content": [ { "text": "Welcome to Mailrith.", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "previewText": "Thanks for joining", "replyToEmail": "", "subject": "Welcome", "trackClicks": true, "trackOpens": true, "utmCampaign": "", "utmContent": "", "utmMedium": "", "utmSource": "", "utmTerm": "" }, "id": "send-welcome-email", "kind": "action", "type": "send_email" } ], "trigger": { "tagIds": [ "tag_welcome" ], "type": "tag_added" }, "version": 2 } ], "properties": { "entryPoints": { "items": { "$ref": "#/$defs/AutomationEntryPoint" }, "type": "array" }, "steps": { "items": { "$ref": "#/$defs/AutomationStep" }, "maxItems": 256, "type": "array" }, "trigger": { "anyOf": [ { "$ref": "#/$defs/AutomationTrigger" }, { "type": "null" } ] }, "triggers": { "items": { "$ref": "#/$defs/AutomationTrigger" }, "type": "array" }, "version": { "enum": [ 2 ], "type": "integer" } }, "required": [ "steps" ], "type": "object" }, "AutomationEntryPoint": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "trigger": { "$ref": "#/$defs/AutomationTrigger" } }, "required": [ "id", "trigger" ], "type": "object" }, "AutomationPath": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "label" ], "type": "object" }, "AutomationStep": { "additionalProperties": false, "properties": { "branches": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" }, "config": { "$ref": "#/$defs/AutomationStepConfig" }, "id": { "type": "string" }, "kind": { "enum": [ "event", "action", "condition" ], "type": "string" }, "nextStepId": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "paths": { "items": { "$ref": "#/$defs/AutomationPath" }, "type": "array" }, "stats": { "$ref": "#/$defs/EmailEngagementStats" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "sequence_completed", "add_tag", "remove_tag", "add_to_sequence", "remove_from_sequence", "change_subscriber_status", "wait", "update_custom_field", "send_email", "send_internal_notification", "start_automation", "remove_from_automation", "webhook", "end_automation", "has_tag", "custom_field_match", "sequence_membership", "subscriber_status", "email_opened", "email_clicked" ], "type": "string" } }, "required": [ "id", "kind", "type" ], "type": "object" }, "AutomationStepConfig": { "additionalProperties": false, "properties": { "authType": { "enum": [ "none", "bearer" ], "type": "string" }, "automationId": { "type": "string" }, "bearerTokenConfigured": { "description": "True when Mailrith has a saved webhook bearer token. Send this unchanged during an update to preserve the saved value. The token value is never returned.", "type": "boolean" }, "bodyDocument": { "$ref": "#/$defs/BroadcastEmailDocument" }, "customFieldId": { "type": "string" }, "date": { "format": "date", "type": "string" }, "dateSource": { "enum": [ "custom_field", "fixed_date" ], "type": "string" }, "durationUnit": { "enum": [ "minute", "hour", "day", "week" ], "type": "string" }, "durationValue": { "minimum": 0, "type": "number" }, "emailId": { "type": "string" }, "exitNextStepId": { "type": [ "string", "null" ] }, "headers": { "items": { "additionalProperties": false, "properties": { "configured": { "description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value.", "type": "boolean" }, "key": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "includeCustomFields": { "type": "boolean" }, "includeSubscriber": { "type": "boolean" }, "includeTags": { "type": "boolean" }, "lookbackDays": { "minimum": 1, "type": "integer" }, "magicLinkId": { "type": "string" }, "method": { "enum": [ "POST", "PUT", "PATCH" ], "type": "string" }, "mode": { "enum": [ "duration", "until_custom_date", "until_custom_field_date" ], "type": "string" }, "operation": { "enum": [ "set", "clear", "increment", "decrement", "set_today", "add_choices", "remove_choices", "set_true", "set_false", "toggle" ], "type": "string" }, "operator": { "enum": [ "equals", "not_equals", "contains", "not_contains", "starts_with", "ends_with", "exists", "missing", "greater_than", "greater_than_or_equal", "less_than", "less_than_or_equal", "on", "not_on", "before", "on_or_before", "after", "on_or_after", "contains_any", "contains_all", "does_not_contain_any", "is_checked", "is_not_checked" ], "type": "string" }, "previewText": { "type": "string" }, "recipientEmail": { "format": "email", "type": "string" }, "replyToEmail": { "type": "string" }, "sequenceId": { "type": "string" }, "status": { "type": "string" }, "statuses": { "items": { "type": "string" }, "type": "array" }, "subject": { "description": "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.", "type": "string" }, "tagId": { "type": "string" }, "timeOfDay": { "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$", "type": "string" }, "trackClicks": { "type": "boolean" }, "trackOpens": { "type": "boolean" }, "url": { "format": "uri", "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "utmMedium": { "type": "string" }, "utmSource": { "type": "string" }, "utmTerm": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "waitForCompletion": { "type": "boolean" }, "waitMode": { "enum": [ "duration", "custom_date" ], "type": "string" }, "waitUntilComplete": { "type": "boolean" } }, "type": "object" }, "AutomationTrigger": { "additionalProperties": false, "properties": { "magicLinkId": { "type": [ "string", "null" ] }, "magicLinkIds": { "items": { "type": "string" }, "type": "array" }, "operator": { "enum": [ "is", "is_not" ], "type": "string" }, "statuses": { "items": { "enum": [ "Active", "Unconfirmed", "Unsubscribed", "Complained", "Bounced", "Blocked" ], "type": "string" }, "type": "array" }, "tagId": { "type": [ "string", "null" ] }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "tag_added", "tag_removed", "magic_link_clicked", "subscriber_status" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailEngagementStats": { "additionalProperties": false, "properties": { "bouncedCount": { "minimum": 0, "type": "integer" }, "clickedCount": { "minimum": 0, "type": "integer" }, "clickedSubscriberCount": { "minimum": 0, "type": "integer" }, "complainedCount": { "minimum": 0, "type": "integer" }, "engagedCount": { "minimum": 0, "type": "integer" }, "openedCount": { "minimum": 0, "type": "integer" }, "recipientCount": { "minimum": 0, "type": "integer" }, "sentCountsByDay": { "additionalProperties": { "minimum": 0, "type": "integer" }, "type": "object" }, "unsubscribedCount": { "minimum": 0, "type": "integer" } }, "required": [ "recipientCount", "openedCount", "clickedCount", "unsubscribedCount" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateAutomationStatus", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/Automation" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": true, "readOnlyHint": false, "title": "Change an automation status" } }, { "name": "email_templates_list", "title": "List email templates", "description": "Returns reusable email templates linked to the authenticated workspace. Permission: email_templates:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "limit": { "description": "Maximum number of items to return.", "maximum": 100, "minimum": 1, "type": "integer" }, "search": { "description": "Filter email templates by name.", "maxLength": 200, "type": "string" }, "starting_after": { "description": "Opaque cursor returned by the previous page.", "type": "string" } }, "type": "object" }, "outputSchema": { "$defs": { "EmailTemplateSummary": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "maxLength": 160, "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "workspaces": { "items": { "$ref": "#/$defs/WorkspaceReference" }, "type": "array" } }, "required": [ "id", "name", "enabled", "workspaces", "created_at", "updated_at", "self" ], "type": "object" }, "Pagination": { "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "has_more", "next_cursor" ], "type": "object" }, "WorkspaceReference": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "listEmailTemplates", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "items": { "$ref": "#/$defs/EmailTemplateSummary" }, "type": "array" }, "pagination": { "$ref": "#/$defs/Pagination" } }, "required": [ "data", "pagination" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "List email templates" } }, { "name": "email_templates_create", "title": "Create an email template", "description": "Creates a reusable email template scoped to the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: email_templates:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailTemplateUpsertRequest": { "additionalProperties": false, "anyOf": [ { "required": [ "body_document" ] }, { "required": [ "starting_point_id" ] } ], "properties": { "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "Structured email editor content. The serialized document must be 512000 bytes or less. 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." }, "enabled": { "type": "boolean" }, "name": { "maxLength": 160, "type": "string" }, "starting_point_id": { "description": "Creates the email template from this canonical starting point. Do not also provide body_document.", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/EmailTemplateUpsertRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "idempotency_key": { "description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.", "maxLength": 256, "type": "string" } }, "required": [ "body" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailTemplate": { "properties": { "body": { "type": "string" }, "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "Structured email editor content. The serialized document must be 512000 bytes or less. 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." }, "created_at": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "maxLength": 160, "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "workspaces": { "items": { "$ref": "#/$defs/WorkspaceReference" }, "type": "array" } }, "required": [ "id", "name", "body", "body_document", "enabled", "workspaces", "created_at", "updated_at", "self" ], "type": "object" }, "WorkspaceReference": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "createEmailTemplate", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/EmailTemplate" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "readOnlyHint": false, "title": "Create an email template" } }, { "name": "email_templates_get", "title": "Get an email template", "description": "Returns a reusable email template linked to the authenticated workspace. Permission: email_templates:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "additionalProperties": false, "properties": { "template_id": { "description": "The email template identifier.", "type": "string" } }, "required": [ "template_id" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailTemplate": { "properties": { "body": { "type": "string" }, "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "Structured email editor content. The serialized document must be 512000 bytes or less. 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." }, "created_at": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "maxLength": 160, "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "workspaces": { "items": { "$ref": "#/$defs/WorkspaceReference" }, "type": "array" } }, "required": [ "id", "name", "body", "body_document", "enabled", "workspaces", "created_at", "updated_at", "self" ], "type": "object" }, "WorkspaceReference": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "getEmailTemplate", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/EmailTemplate" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Get an email template" } }, { "name": "email_templates_preview", "title": "Preview an email template for a Subscriber", "description": "Renders one template using a saved Subscriber's name, email, and custom fields without sending or saving anything. Permissions: subscribers:read, email_templates:read. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "SubscriberPreviewRequest": { "additionalProperties": false, "properties": { "subscriber_id": { "description": "The saved Subscriber whose name, email, and custom fields should be used for personalization.", "type": "string" } }, "required": [ "subscriber_id" ], "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/SubscriberPreviewRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "template_id": { "description": "The email template identifier.", "type": "string" } }, "required": [ "template_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "EmailTemplatePreview": { "additionalProperties": false, "properties": { "html": { "type": "string" }, "subscriber_id": { "type": "string" }, "template_id": { "type": "string" }, "text": { "type": "string" } }, "required": [ "template_id", "subscriber_id", "html", "text" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "previewEmailTemplate", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/EmailTemplatePreview" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": true, "title": "Preview an email template for a Subscriber" } }, { "name": "email_templates_update", "title": "Update an email template", "description": "Updates the content or enabled state of an existing email template. Effect: workspace-change. Retry after reading the current resource state. Permission: email_templates:write. API reference: https://mailrith.com/developers/api-reference.", "inputSchema": { "$defs": { "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailTemplateUpdateRequest": { "additionalProperties": false, "minProperties": 1, "properties": { "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "Structured email editor content. The serialized document must be 512000 bytes or less. 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." }, "enabled": { "type": "boolean" }, "name": { "maxLength": 160, "type": "string" } }, "type": "object" } }, "additionalProperties": false, "properties": { "body": { "$ref": "#/$defs/EmailTemplateUpdateRequest", "description": "The exact JSON request body defined by the Mailrith public API contract.", "type": "object" }, "template_id": { "description": "The email template identifier.", "type": "string" } }, "required": [ "template_id", "body" ], "type": "object" }, "outputSchema": { "$defs": { "BroadcastEmailDocument": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailNode" } ], "description": "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.", "example": { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" }, "examples": [ { "content": [ { "content": [ { "text": "Hello [Subscriber_Name, fallback=\"friend\"].", "type": "text" } ], "type": "paragraph" } ], "type": "doc" } ] }, "BroadcastEmailMark": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "color": { "type": "string" }, "fontSize": { "type": "string" }, "href": { "type": "string" } }, "type": "object" }, "type": { "enum": [ "bold", "italic", "strike", "underline", "link", "textStyle", "highlight" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "BroadcastEmailNode": { "additionalProperties": false, "properties": { "attrs": { "additionalProperties": false, "properties": { "align": { "enum": [ "left", "center", "right" ], "type": "string" }, "alt": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundImageUrl": { "type": "string" }, "blockquoteBorderColor": { "type": "string" }, "borderColor": { "type": "string" }, "borderRadius": { "enum": [ "none", "normal", "small", "large", "full" ], "type": "string" }, "borderWidth": { "enum": [ "none", "normal", "large" ], "type": "string" }, "caption": { "type": "string" }, "columns": { "enum": [ 1, 2, 3 ], "type": "integer" }, "crop": { "enum": [ "none", "square", "circle" ], "type": "string" }, "fillColumn": { "type": "boolean" }, "href": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layoutAlignment": { "enum": [ "left", "center" ], "type": "string" }, "level": { "enum": [ 1, 2, 3 ], "type": "integer" }, "linkColor": { "type": "string" }, "margin": { "enum": [ "none", "normal", "large" ], "type": "string" }, "padding": { "enum": [ "none", "normal", "large" ], "type": "string" }, "size": { "enum": [ "small", "medium", "large" ], "type": "string" }, "source": { "enum": [ "unsplash" ], "type": "string" }, "src": { "type": "string" }, "textAlign": { "enum": [ "left", "center", "right", "justify" ], "type": "string" }, "textColor": { "type": "string" }, "title": { "type": "string" }, "unsplash": { "additionalProperties": false, "properties": { "photoId": { "type": "string" }, "photographerName": { "type": "string" }, "photographerUrl": { "type": "string" }, "photographerUsername": { "type": "string" }, "unsplashUrl": { "type": "string" } }, "required": [ "photographerName" ], "type": "object" }, "verticalAlign": { "enum": [ "top", "middle", "bottom" ], "type": "string" }, "width": { "enum": [ "default", "large", "full", "fit" ], "type": "string" }, "widthPercent": { "maximum": 100, "minimum": 1, "type": "number" } }, "type": "object" }, "content": { "items": { "$ref": "#/$defs/BroadcastEmailNode" }, "type": "array" }, "marks": { "items": { "$ref": "#/$defs/BroadcastEmailMark" }, "type": "array" }, "text": { "type": "string" }, "type": { "enum": [ "doc", "paragraph", "heading", "text", "hardBreak", "bulletList", "orderedList", "listItem", "blockquote", "emailSection", "emailSectionColumn", "emailButton", "image", "horizontalRule" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "EmailTemplate": { "properties": { "body": { "type": "string" }, "body_document": { "allOf": [ { "$ref": "#/$defs/BroadcastEmailDocument" } ], "description": "Structured email editor content. The serialized document must be 512000 bytes or less. 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." }, "created_at": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "maxLength": 160, "type": "string" }, "self": { "description": "Stable relative Public API path for retrieving this resource.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "workspaces": { "items": { "$ref": "#/$defs/WorkspaceReference" }, "type": "array" } }, "required": [ "id", "name", "body", "body_document", "enabled", "workspaces", "created_at", "updated_at", "self" ], "type": "object" }, "WorkspaceReference": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "additionalProperties": false, "anyOf": [ { "required": [ "response" ] }, { "required": [ "error" ] } ], "properties": { "error": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "category": { "enum": [ "validation", "authentication", "permission", "conflict", "rate_limit", "transient", "unknown" ], "type": "string" }, "code": { "type": "string" }, "credential_type": { "enum": [ "workspace_api_key", "oauth_access_token" ], "type": "string" }, "details": { "additionalProperties": false, "properties": { "field": { "type": "string" }, "reason": { "type": "string" }, "resource": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "type": "object" }, "issues": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "code", "message" ], "type": "object" }, "maxItems": 20, "type": "array" }, "message": { "type": "string" }, "missing_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "permissions_help_url": { "format": "uri", "type": "string" }, "prerequisite": { "additionalProperties": false, "properties": { "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "resource": { "type": "string" }, "setup_url": { "format": "uri", "type": "string" }, "state": { "enum": [ "missing", "disabled" ], "type": "string" }, "work_profile": { "type": "string" } }, "required": [ "resource", "state" ], "type": "object" }, "recommended_work_profiles": { "items": { "type": "string" }, "maxItems": 20, "type": "array" }, "reconnect_required": { "type": "boolean" }, "recovery": { "additionalProperties": false, "properties": { "access_update_url": { "format": "uri", "type": "string" }, "action": { "enum": [ "replace_api_key", "reconnect_oauth" ], "type": "string" }, "message": { "type": "string" }, "permissions_help_url": { "format": "uri", "type": "string" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "action", "message" ], "type": "object" }, "replacement_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "required_scopes": { "items": { "type": "string" }, "maxItems": 50, "type": "array" }, "retry": { "additionalProperties": false, "properties": { "guidance": { "type": "string" }, "safe": { "type": "boolean" } }, "required": [ "safe", "guidance" ], "type": "object" }, "retryable": { "type": "boolean" }, "status": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "category", "status", "code", "message", "retryable" ], "type": "object" }, "operation_id": { "const": "updateEmailTemplate", "description": "The stable Mailrith public API operation ID.", "type": "string" }, "request_id": { "description": "The stable correlation ID for this MCP tool invocation.", "pattern": "^mcp_[0-9a-f-]{36}$", "type": "string" }, "response": { "properties": { "data": { "$ref": "#/$defs/EmailTemplate" } }, "required": [ "data" ], "type": "object" } }, "required": [ "operation_id", "request_id" ], "type": "object" }, "annotations": { "destructiveHint": true, "idempotentHint": true, "openWorldHint": false, "readOnlyHint": false, "title": "Update an email template" } } ] }, "name": "Mailrith Email Marketing", "note": "Indexed from the official MCP registry: facts and our own checks, not reviewed, so no score, grade or rank.", "packages": [ { "registryType": "npm", "identifier": "@mailrith/mcp-server", "version": "1.1.1", "transport": "stdio" } ], "pageJsonUrl": "https://www.anchorterminal.com/tools/mailrith.json", "popularity": { "githubStars": 0, "npmWeekly": 62 }, "registryName": "com.mailrith/mailrith", "remotes": [ { "type": "streamable-http", "url": "https://api.mailrith.com/mcp" } ], "repository": "https://github.com/anrawool/mailrith-agent-platform", "reviewed": false, "slug": "mailrith", "source": "the official MCP registry", "sourceUrl": "https://registry.modelcontextprotocol.io/v0.1/servers?search=com.mailrith/mailrith", "summary": "Manage Subscribers, Broadcasts, Sequences, Automations, and reporting in Mailrith.", "updatedAt": "2026-08-27T05:22:18Z", "url": "https://www.anchorterminal.com/tools/mailrith", "vendor": "mailrith.com", "vendorUrl": "https://mailrith.com/developers/mcp", "version": "1.1.1", "websiteUrl": "https://mailrith.com/developers/mcp", "where": "both", "why": [ "vendor" ] } }, "kind": "anchor.page", "links": { "api": "https://www.anchorterminal.com/api/v1/index.json", "html": "https://www.anchorterminal.com/tools/mailrith", "json": "https://www.anchorterminal.com/tools/mailrith.json", "llms": "https://www.anchorterminal.com/llms.txt", "markdown": "https://www.anchorterminal.com/tools/mailrith.md", "slim": "https://www.anchorterminal.com/tools/mailrith.min.md" }, "markdown": "# Mailrith Email Marketing\n\n\u003e Indexed, not reviewed: facts from the official MCP registry and our own checks. No score, grade or rank, and not in the rankings until the panel reviews it. How the index works: https://www.anchorterminal.com/indexed/\n\n- Kind: MCP server, by mailrith.com (https://mailrith.com/developers/mcp)\n- Category: Email delivery APIs (https://www.anchorterminal.com/categories/email.md)\n- Listed because: It's published in the registry under mailrith.com, a namespace the registry only gives to whoever proves they control that domain.\n- What the official MCP registry says: Manage Subscribers, Broadcasts, Sequences, Automations, and reporting in Mailrith.\n\n## Facts\n\n- MCP registry: `com.mailrith/mailrith` 1.1.1\n- Endpoint: https://api.mailrith.com/mcp (streamable HTTP)\n- Package: npm `@mailrith/mcp-server` (stdio)\n- Source: https://github.com/anrawool/mailrith-agent-platform\n- Website: https://mailrith.com/developers/mcp\n- npm downloads a week: 62\n- GitHub stars: 0\n- Registry entry updated: 2026-08-27\n\n## Tools\n\n- Tools it lists (55, about 127,059 tokens of context, `tools/list` without credentials over MCP 2025-11-25, checked 2026-10-05 22:34 UTC):\n - `discovery_get_capabilities` (read-only): Returns the current workspace context, discovery URLs, shared request conventions, supported webhook events, and public resource operations available to the…\n - `workspace_get` (read-only): Returns the authenticated workspace profile and mailing context used by broadcasts, sequences, automations, forms, and magic links. Permission: workspace:read.…\n - `sender_identities_list` (read-only): Returns a bounded page of enabled sender names, addresses, and provider types that can be selected for Broadcasts and Sequences. Provider credentials and…\n - `sender_identities_get` (read-only): Returns one enabled sender name, address, and provider type by stable identifier. Provider credentials and configuration are never returned. Permission:…\n - `analytics_create_report` (writes): Runs from compact rollups. Ranges through 31 days complete inline; longer ranges are queued. Results expire after 24 hours and never exceed 100 rows. Effect:…\n - `analytics_get_report` (read-only): Returns one unexpired bounded analytics report by identifier. Permission: analytics:read. Pagination: use bounded pages and returned cursors. API reference:…\n - `subscribers_list` (read-only): Returns subscribers in the authenticated workspace, sorted from newest to oldest. Permission: subscribers:read. Pagination: use bounded pages and returned…\n - `subscribers_get` (read-only): Returns one Subscriber by its stable identifier from the authenticated workspace. Permission: subscribers:read. API reference:…\n - `subscribers_upsert` (writes): Creates a new subscriber when the email does not exist in the workspace. If the email already exists, the API updates the existing subscriber unless…\n - `subscribers_update` (writes): Updates profile fields, status, custom fields, tags, or sequence assignments for one subscriber. Fields omitted from the request stay unchanged. Blank optional…\n - `subscribers_update_status` (writes): Changes the delivery status for one Subscriber without changing profile, targeting, or Sequence enrollment fields. Making a Subscriber Active requires…\n - `subscribers_add_tag` (writes): Adds the selected Tag to a Subscriber. If the Subscriber already has the Tag, the API returns the Subscriber unchanged. Effect: external-email. Retry after…\n - `subscribers_remove_tag` (writes): Removes the selected tag from a subscriber. If the subscriber does not have the tag, the API returns the subscriber unchanged. Effect: external-email. Retry…\n - `subscribers_add_to_sequence` (writes): Adds the selected subscriber to the selected sequence. If the subscriber is already in the sequence, the API returns the subscriber unchanged. Effect:…\n - `subscribers_remove_from_sequence` (writes): Removes the selected subscriber from the selected sequence. If the subscriber is not in the sequence, the API returns the subscriber unchanged. Effect:…\n - `tags_list` (read-only): Returns tags in the authenticated workspace. Permission: tags:read. Pagination: use bounded pages and returned cursors. API reference:…\n - `tags_get` (read-only): Returns one Tag from the authenticated workspace. Permission: tags:read. API reference: https://mailrith.com/developers/api-reference.\n - `tags_create` (writes): Creates a new tag in the authenticated workspace. The GDPR consent tag names can be created and applied like other tags when you need to apply consent…\n - `custom_fields_list` (read-only): Returns a bounded page of custom fields in the authenticated workspace, including each field's exact ready-to-use email personalization token. Permission:…\n - `custom_fields_get` (read-only): Returns one custom field from the authenticated workspace, including its exact ready-to-use email personalization token. Permission: custom_fields:read. API…\n - `segments_list` (read-only): Returns saved segments from the authenticated workspace. Permission: segments:read. Pagination: use bounded pages and returned cursors. API reference:…\n - `segments_get` (read-only): Returns one saved segment from the authenticated workspace. Permission: segments:read. API reference: https://mailrith.com/developers/api-reference.\n - `segments_preview` (read-only): Returns subscriber counts for an unsaved segment definition. Include `current_segment_id` when previewing edits to an existing segment so circular segment…\n - `broadcasts_list` (read-only): Returns broadcast drafts, scheduled sends, active sends, and completed sends. Permission: broadcasts:read. Pagination: use bounded pages and returned cursors.…\n - `broadcasts_create` (writes): Creates a broadcast draft in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: broadcasts:write. API…\n - `broadcasts_get` (read-only): Returns a broadcast draft, scheduled send, active send, or completed send. Permission: broadcasts:read. API reference:…\n - `broadcasts_update` (writes): Updates an existing Broadcast draft. Scheduled, running, completed, and failed Broadcasts cannot be changed here. Before changing a scheduled Broadcast, read…\n - `broadcasts_preflight` (read-only): Optionally checks the current Subscriber estimate, provider capacity, sender setup, event tracking, and blocking issues. This diagnostic is not required before…\n - `broadcasts_send_test` (writes): Sends a test message from an existing Broadcast that has an email delivery connection. Provide a saved Subscriber ID for personalization; use subscribers_list…\n - `broadcasts_schedule` (writes): Schedules a draft for future delivery, or changes the delivery time of an existing scheduled Broadcast. This uses Mailrith's durable scheduled-send path and…\n - `broadcasts_unschedule` (writes): Returns a scheduled Broadcast to draft state before delivery starts. Effect: workspace-change. Retry after reading the current resource state. Permissions:…\n - `broadcasts_send` (writes): Immediately creates durable preparation for a broadcast draft or scheduled send. Mailrith calculates the exact Subscriber total and checks provider readiness…\n - `broadcasts_cancel` (writes): Requests cancellation for delivery work that has not reached the provider. Provider-accepted emails cannot be recalled. Repeat the same request with the same…\n - `broadcasts_get_send_progress` (read-only): Returns bounded delivery progress, current rates, timing, outcome counts, and pause state. Poll until terminal is true; use 5 to 10 second intervals while…\n - `sequences_list` (read-only): Returns sequences in the authenticated workspace. Permission: sequences:read. Pagination: use bounded pages and returned cursors. API reference:…\n - `sequences_create` (writes): Creates a sequence in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: sequences:write. API reference:…\n - `sequences_get` (read-only): Returns one sequence from the authenticated workspace. Permission: sequences:read. API reference: https://mailrith.com/developers/api-reference.\n - `sequences_update` (writes): Updates an existing paused Sequence. Before changing a running Sequence, read it by ID, retain its status in the current task only, pause it, apply the update,…\n - `sequences_preflight` (read-only): Checks the saved Sequence, its published emails, and its email delivery connection without changing data or sending email. Permission: sequences:read. API…\n - `sequences_preview_journey` (read-only): Returns the bounded saved email timeline and shows which messages a selected Subscriber is eligible to receive, without enrolling the Subscriber or sending…\n - `sequences_send_test` (writes): Sends up to five selected saved Sequence emails to one explicit test address. This does not enroll a Subscriber, start the Sequence, or write delivery…\n - `sequences_update_status` (writes): Starts or pauses one Sequence without changing its content or delivery settings. Effect: external-email. Retry after reading the current resource state.…\n - `automations_list` (read-only): Returns automations in the authenticated workspace. Permission: automations:read. Pagination: use bounded pages and returned cursors. API reference:…\n - `automations_create` (writes): Creates an automation in the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission: automations:write. API…\n - `automations_get` (read-only): Returns one automation from the authenticated workspace. Permission: automations:read. API reference: https://mailrith.com/developers/api-reference.\n - `automations_update` (writes): 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,…\n - `automations_preflight` (read-only): Checks the saved Automation definition and email delivery prerequisite without running any action. Permission: automations:read. API reference:…\n - `automations_preview_journey` (read-only): Shows the bounded path a selected Subscriber would take through the current saved conditions without running actions or writing history. Permissions:…\n - `automations_send_test` (writes): Sends up to five selected saved Automation email steps to one explicit test address. This does not start the Automation or run other actions. Effect:…\n - `automations_update_status` (writes): Starts, pauses, or returns one Automation to draft without changing its definition. Effect: external-email. Retry after reading the current resource state.…\n - `email_templates_list` (read-only): Returns reusable email templates linked to the authenticated workspace. Permission: email_templates:read. Pagination: use bounded pages and returned cursors.…\n - `email_templates_create` (writes): Creates a reusable email template scoped to the authenticated workspace. Effect: workspace-change. Retry with the same idempotency_key. Permission:…\n - `email_templates_get` (read-only): Returns a reusable email template linked to the authenticated workspace. Permission: email_templates:read. API reference:…\n - `email_templates_preview` (read-only): Renders one template using a saved Subscriber's name, email, and custom fields without sending or saving anything. Permissions: subscribers:read,…\n - `email_templates_update` (writes): Updates the content or enabled state of an existing email template. Effect: workspace-change. Retry after reading the current resource state. Permission:…\n- How its tools read to an agent (0 errors, 75 warnings, 0 notes, about 127,059 tokens; rules at https://www.anchorterminal.com/check.md; not part of the score):\n - warn TC13 analytics_create_report: body (object with no properties)\n - warn TC13 automations_create: body (object with no properties)\n - warn TC13 automations_send_test: body (object with no properties)\n - warn TC13 automations_update: body (object with no properties)\n - warn TC13 automations_update_status: body (object with no properties)\n - warn TC13 broadcasts_create: body (object with no properties)\n - warn TC13 broadcasts_schedule: body (object with no properties)\n - warn TC13 broadcasts_send_test: body (object with no properties)\n - warn TC13 broadcasts_update: body (object with no properties)\n - warn TC13 email_templates_create: body (object with no properties)\n - warn TC13 email_templates_preview: body (object with no properties)\n - warn TC13 email_templates_update: body (object with no properties)\n - warn TC13 segments_preview: body (object with no properties)\n - warn TC13 sequences_create: body (object with no properties)\n - warn TC13 sequences_send_test: body (object with no properties)\n - warn TC13 sequences_update: body (object with no properties)\n - warn TC13 sequences_update_status: body (object with no properties)\n - warn TC13 subscribers_update: body (object with no properties)\n - warn TC13 subscribers_update_status: body (object with no properties)\n - warn TC13 subscribers_upsert: body (object with no properties)\n - warn TC13 tags_create: body (object with no properties)\n - warn TC15 analytics_create_report: inputSchema uses $ref/$defs\n - warn TC15 automations_create: inputSchema uses $ref/$defs\n - warn TC15 automations_send_test: inputSchema uses $ref/$defs\n\n- JSON: https://www.anchorterminal.com/api/v1/tools/mailrith.json\n- Being indexed says nothing about quality, and nobody can pay for it. Ask for a review: https://www.anchorterminal.com/builders/#claiming\n", "meta": { "attribution": "Anchor Terminal (https://www.anchorterminal.com)", "docs": "https://www.anchorterminal.com/docs/", "generatedAt": "2026-10-05", "license": "CC-BY-4.0", "method": "https://www.anchorterminal.com/benchmark/", "methodology": "0.3", "openapi": "https://www.anchorterminal.com/openapi.json", "preview": false, "run": "2026-10-01", "runLabel": "October 2026 research run" }, "page": { "breadcrumbs": [ { "name": "Home", "url": "https://www.anchorterminal.com/" }, { "name": "Terminal", "url": "https://www.anchorterminal.com/tools/" }, { "name": "Indexed", "url": "https://www.anchorterminal.com/indexed/" }, { "name": "Mailrith Email Marketing", "url": "" } ], "description": "Mailrith Email Marketing, an MCP server by mailrith.com, listed from the official MCP registry. Indexed, not reviewed: facts and our own checks, no score or ranking. Manage Subscribers, Broadcasts, Sequences, Automations, and reporting in Mailrith.", "facts": [ "not reviewed", "not ranked", "facts only" ], "h1": "Mailrith Email Marketing", "image": "https://www.anchorterminal.com/assets/og/indexed.png", "path": "/tools/mailrith", "published": "", "section": "indexed", "title": "Mailrith Email Marketing, indexed from the official MCP registry", "toc": null, "updated": "2026-10-05", "url": "https://www.anchorterminal.com/tools/mailrith" }, "tokens": { "markdown": 3600, "slim": 3530 }, "version": 1 }