Manage Subscribers, Broadcasts, Sequences, Automations, and reporting in Mailrith.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
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.
The exact JSON request body defined by the Mailrith public API contract.
Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"AnalyticsReportCreateRequest": {
"type": "object",
"required": [
"from",
"to"
],
"properties": {
"to": {
"type": "string",
"format": "date"
},
"from": {
"type": "string",
"format": "date"
},
"group_by": {
"type": "array",
"items": {
"enum": [
"source_type",
"source",
"message",
"provider",
"day"
],
"type": "string"
},
"maxItems": 2
},
"source_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20
},
"source_types": {
"type": "array",
"items": {
"enum": [
"broadcast",
"sequence",
"automation"
],
"type": "string"
},
"maxItems": 3
},
"compare_previous": {
"type": "boolean",
"default": true
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/AnalyticsReportCreateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum aggregate row count, from 1 to 50. |
| report_id* | string | Stable analytics report identifier. |
| starting_after | string | Opaque next_cursor returned by the previous report page. |
{
"type": "object",
"required": [
"report_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Maximum aggregate row count, from 1 to 50."
},
"report_id": {
"type": "string",
"description": "Stable analytics report identifier."
},
"starting_after": {
"type": "string",
"description": "Opaque next_cursor returned by the previous report page."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"AutomationPath": {
"type": "object",
"required": [
"id",
"label"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"weight": {
"type": [
"number",
"null"
]
},
"nextStepId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationStep": {
"type": "object",
"required": [
"id",
"kind",
"type"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"event",
"action",
"condition"
],
"type": "string"
},
"note": {
"type": [
"string",
"null"
]
},
"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"
},
"paths": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationPath"
}
},
"stats": {
"$ref": "#/$defs/EmailEngagementStats"
},
"config": {
"$ref": "#/$defs/AutomationStepConfig"
},
"branches": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"nextStepId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationTrigger": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"tag_added",
"tag_removed",
"magic_link_clicked",
"subscriber_status"
],
"type": "string"
},
"tagId": {
"type": [
"string",
"null"
]
},
"tagIds": {
"type": "array",
"items": {
"type": "string"
}
},
"operator": {
"enum": [
"is",
"is_not"
],
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"enum": [
"Active",
"Unconfirmed",
"Unsubscribed",
"Complained",
"Bounced",
"Blocked"
],
"type": "string"
}
},
"magicLinkId": {
"type": [
"string",
"null"
]
},
"magicLinkIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"AutomationDefinition": {
"type": "object",
"example": {
"steps": [
{
"id": "send-welcome-email",
"kind": "action",
"type": "send_email",
"config": {
"subject": "Welcome",
"utmTerm": "",
"utmMedium": "",
"utmSource": "",
"trackOpens": true,
"utmContent": "",
"previewText": "Thanks for joining",
"trackClicks": true,
"utmCampaign": "",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to Mailrith.",
"type": "text"
}
]
}
]
},
"replyToEmail": ""
}
}
],
"trigger": {
"type": "tag_added",
"tagIds": [
"tag_welcome"
]
},
"version": 2
},
"examples": [
{
"steps": [
{
"id": "send-welcome-email",
"kind": "action",
"type": "send_email",
"config": {
"subject": "Welcome",
"utmTerm": "",
"utmMedium": "",
"utmSource": "",
"trackOpens": true,
"utmContent": "",
"previewText": "Thanks for joining",
"trackClicks": true,
"utmCampaign": "",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to Mailrith.",
"type": "text"
}
]
}
]
},
"replyToEmail": ""
}
}
],
"trigger": {
"type": "tag_added",
"tagIds": [
"tag_welcome"
]
},
"version": 2
}
],
"required": [
"steps"
],
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationStep"
},
"maxItems": 256
},
"trigger": {
"anyOf": [
{
"$ref": "#/$defs/AutomationTrigger"
},
{
"type": "null"
}
]
},
"version": {
"enum": [
2
],
"type": "integer"
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationTrigger"
}
},
"entryPoints": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationEntryPoint"
}
}
},
"additionalProperties": false
},
"AutomationEntryPoint": {
"type": "object",
"required": [
"id",
"trigger"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"trigger": {
"$ref": "#/$defs/AutomationTrigger"
},
"description": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationStepConfig": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"date": {
"type": "string",
"format": "date"
},
"mode": {
"enum": [
"duration",
"until_custom_date",
"until_custom_field_date"
],
"type": "string"
},
"tagId": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"method": {
"enum": [
"POST",
"PUT",
"PATCH"
],
"type": "string"
},
"status": {
"type": "string"
},
"emailId": {
"type": "string"
},
"headers": {
"type": "array",
"items": {
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string",
"writeOnly": true,
"description": "A secret header value accepted on writes and never returned."
},
"configured": {
"type": "boolean",
"description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value."
}
},
"additionalProperties": false
}
},
"subject": {
"type": "string",
"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."
},
"utmTerm": {
"type": "string"
},
"authType": {
"enum": [
"none",
"bearer"
],
"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"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"waitMode": {
"enum": [
"duration",
"custom_date"
],
"type": "string"
},
"operation": {
"enum": [
"set",
"clear",
"increment",
"decrement",
"set_today",
"add_choices",
"remove_choices",
"set_true",
"set_false",
"toggle"
],
"type": "string"
},
"timeOfDay": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"utmMedium": {
"type": "string"
},
"utmSource": {
"type": "string"
},
"dateSource": {
"enum": [
"custom_field",
"fixed_date"
],
"type": "string"
},
"sequenceId": {
"type": "string"
},
"trackOpens": {
"type": "boolean"
},
"utmContent": {
"type": "string"
},
"bearerToken": {
"type": "string",
"writeOnly": true
},
"includeTags": {
"type": "boolean"
},
"magicLinkId": {
"type": "string"
},
"previewText": {
"type": "string"
},
"trackClicks": {
"type": "boolean"
},
"utmCampaign": {
"type": "string"
},
"automationId": {
"type": "string"
},
"bodyDocument": {
"$ref": "#/$defs/BroadcastEmailDocument"
},
"durationUnit": {
"enum": [
"minute",
"hour",
"day",
"week"
],
"type": "string"
},
"lookbackDays": {
"type": "integer",
"minimum": 1
},
"replyToEmail": {
"type": "string"
},
"customFieldId": {
"type": "string"
},
"durationValue": {
"type": "number",
"minimum": 0
},
"exitNextStepId": {
"type": [
"string",
"null"
]
},
"recipientEmail": {
"type": "string",
"format": "email"
},
"includeSubscriber": {
"type": "boolean"
},
"waitForCompletion": {
"type": "boolean"
},
"waitUntilComplete": {
"type": "boolean"
},
"includeCustomFields": {
"type": "boolean"
},
"bearerTokenConfigured": {
"type": "boolean",
"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."
}
},
"additionalProperties": false
},
"EmailEngagementStats": {
"type": "object",
"required": [
"recipientCount",
"openedCount",
"clickedCount",
"unsubscribedCount"
],
"properties": {
"openedCount": {
"type": "integer",
"minimum": 0
},
"bouncedCount": {
"type": "integer",
"minimum": 0
},
"clickedCount": {
"type": "integer",
"minimum": 0
},
"engagedCount": {
"type": "integer",
"minimum": 0
},
"recipientCount": {
"type": "integer",
"minimum": 0
},
"complainedCount": {
"type": "integer",
"minimum": 0
},
"sentCountsByDay": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
},
"unsubscribedCount": {
"type": "integer",
"minimum": 0
},
"clickedSubscriberCount": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"AutomationUpsertRequest": {
"type": "object",
"required": [
"name",
"definition"
],
"properties": {
"name": {
"type": "string"
},
"definition": {
"$ref": "#/$defs/AutomationDefinition"
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/AutomationUpsertRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}Returns one automation from the authenticated workspace. Permission: automations:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| automation_id* | string | The automation identifier. |
{
"type": "object",
"required": [
"automation_id"
],
"properties": {
"automation_id": {
"type": "string",
"description": "The automation identifier."
}
},
"additionalProperties": false
}Returns automations in the authenticated workspace. Permission: automations:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of automations to return. |
| search | string | Filter Automations by name or status. |
| starting_after | string | Use the opaque cursor from the previous page to request the next page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of automations to return."
},
"search": {
"type": "string",
"maxLength": 200,
"description": "Filter Automations by name or status."
},
"starting_after": {
"type": "string",
"description": "Use the opaque cursor from the previous page to request the next page."
}
},
"additionalProperties": false
}Checks the saved Automation definition and email delivery prerequisite without running any action. Permission: automations:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| automation_id* | string | The Automation identifier. |
{
"type": "object",
"required": [
"automation_id"
],
"properties": {
"automation_id": {
"type": "string",
"description": "The Automation identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| automation_id* | string | The Automation identifier. |
| subscriber_id* | string | The saved Subscriber whose current state should be evaluated. |
{
"type": "object",
"required": [
"automation_id",
"subscriber_id"
],
"properties": {
"automation_id": {
"type": "string",
"description": "The Automation identifier."
},
"subscriber_id": {
"type": "string",
"description": "The saved Subscriber whose current state should be evaluated."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| automation_id* | string | The Automation identifier. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"WorkflowTestRequest": {
"type": "object",
"required": [
"recipient",
"subscriber_id"
],
"properties": {
"recipient": {
"type": "string",
"format": "email"
},
"message_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5,
"description": "Optional Sequence email IDs or Automation step IDs. Omit to test the first five available messages.",
"uniqueItems": true
},
"subscriber_id": {
"type": "string",
"description": "The saved Subscriber whose personalization should be rendered in every test message."
}
},
"additionalProperties": false
}
},
"required": [
"automation_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/WorkflowTestRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"automation_id": {
"type": "string",
"description": "The Automation identifier."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| automation_id* | string | The automation identifier. |
{
"type": "object",
"$defs": {
"AutomationPath": {
"type": "object",
"required": [
"id",
"label"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"weight": {
"type": [
"number",
"null"
]
},
"nextStepId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationStep": {
"type": "object",
"required": [
"id",
"kind",
"type"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"event",
"action",
"condition"
],
"type": "string"
},
"note": {
"type": [
"string",
"null"
]
},
"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"
},
"paths": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationPath"
}
},
"stats": {
"$ref": "#/$defs/EmailEngagementStats"
},
"config": {
"$ref": "#/$defs/AutomationStepConfig"
},
"branches": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"nextStepId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationTrigger": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"tag_added",
"tag_removed",
"magic_link_clicked",
"subscriber_status"
],
"type": "string"
},
"tagId": {
"type": [
"string",
"null"
]
},
"tagIds": {
"type": "array",
"items": {
"type": "string"
}
},
"operator": {
"enum": [
"is",
"is_not"
],
"type": "string"
},
"statuses": {
"type": "array",
"items": {
"enum": [
"Active",
"Unconfirmed",
"Unsubscribed",
"Complained",
"Bounced",
"Blocked"
],
"type": "string"
}
},
"magicLinkId": {
"type": [
"string",
"null"
]
},
"magicLinkIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"AutomationDefinition": {
"type": "object",
"example": {
"steps": [
{
"id": "send-welcome-email",
"kind": "action",
"type": "send_email",
"config": {
"subject": "Welcome",
"utmTerm": "",
"utmMedium": "",
"utmSource": "",
"trackOpens": true,
"utmContent": "",
"previewText": "Thanks for joining",
"trackClicks": true,
"utmCampaign": "",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to Mailrith.",
"type": "text"
}
]
}
]
},
"replyToEmail": ""
}
}
],
"trigger": {
"type": "tag_added",
"tagIds": [
"tag_welcome"
]
},
"version": 2
},
"examples": [
{
"steps": [
{
"id": "send-welcome-email",
"kind": "action",
"type": "send_email",
"config": {
"subject": "Welcome",
"utmTerm": "",
"utmMedium": "",
"utmSource": "",
"trackOpens": true,
"utmContent": "",
"previewText": "Thanks for joining",
"trackClicks": true,
"utmCampaign": "",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to Mailrith.",
"type": "text"
}
]
}
]
},
"replyToEmail": ""
}
}
],
"trigger": {
"type": "tag_added",
"tagIds": [
"tag_welcome"
]
},
"version": 2
}
],
"required": [
"steps"
],
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationStep"
},
"maxItems": 256
},
"trigger": {
"anyOf": [
{
"$ref": "#/$defs/AutomationTrigger"
},
{
"type": "null"
}
]
},
"version": {
"enum": [
2
],
"type": "integer"
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationTrigger"
}
},
"entryPoints": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationEntryPoint"
}
}
},
"additionalProperties": false
},
"AutomationEntryPoint": {
"type": "object",
"required": [
"id",
"trigger"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"trigger": {
"$ref": "#/$defs/AutomationTrigger"
},
"description": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AutomationStepConfig": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"date": {
"type": "string",
"format": "date"
},
"mode": {
"enum": [
"duration",
"until_custom_date",
"until_custom_field_date"
],
"type": "string"
},
"tagId": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"method": {
"enum": [
"POST",
"PUT",
"PATCH"
],
"type": "string"
},
"status": {
"type": "string"
},
"emailId": {
"type": "string"
},
"headers": {
"type": "array",
"items": {
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string",
"writeOnly": true,
"description": "A secret header value accepted on writes and never returned."
},
"configured": {
"type": "boolean",
"description": "True when Mailrith has a saved value for this header. Send this unchanged during an update to preserve the saved value."
}
},
"additionalProperties": false
}
},
"subject": {
"type": "string",
"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."
},
"utmTerm": {
"type": "string"
},
"authType": {
"enum": [
"none",
"bearer"
],
"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"
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"waitMode": {
"enum": [
"duration",
"custom_date"
],
"type": "string"
},
"operation": {
"enum": [
"set",
"clear",
"increment",
"decrement",
"set_today",
"add_choices",
"remove_choices",
"set_true",
"set_false",
"toggle"
],
"type": "string"
},
"timeOfDay": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"utmMedium": {
"type": "string"
},
"utmSource": {
"type": "string"
},
"dateSource": {
"enum": [
"custom_field",
"fixed_date"
],
"type": "string"
},
"sequenceId": {
"type": "string"
},
"trackOpens": {
"type": "boolean"
},
"utmContent": {
"type": "string"
},
"bearerToken": {
"type": "string",
"writeOnly": true
},
"includeTags": {
"type": "boolean"
},
"magicLinkId": {
"type": "string"
},
"previewText": {
"type": "string"
},
"trackClicks": {
"type": "boolean"
},
"utmCampaign": {
"type": "string"
},
"automationId": {
"type": "string"
},
"bodyDocument": {
"$ref": "#/$defs/BroadcastEmailDocument"
},
"durationUnit": {
"enum": [
"minute",
"hour",
"day",
"week"
],
"type": "string"
},
"lookbackDays": {
"type": "integer",
"minimum": 1
},
"replyToEmail": {
"type": "string"
},
"customFieldId": {
"type": "string"
},
"durationValue": {
"type": "number",
"minimum": 0
},
"exitNextStepId": {
"type": [
"string",
"null"
]
},
"recipientEmail": {
"type": "string",
"format": "email"
},
"includeSubscriber": {
"type": "boolean"
},
"waitForCompletion": {
"type": "boolean"
},
"waitUntilComplete": {
"type": "boolean"
},
"includeCustomFields": {
"type": "boolean"
},
"bearerTokenConfigured": {
"type": "boolean",
"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."
}
},
"additionalProperties": false
},
"EmailEngagementStats": {
"type": "object",
"required": [
"recipientCount",
"openedCount",
"clickedCount",
"unsubscribedCount"
],
"properties": {
"openedCount": {
"type": "integer",
"minimum": 0
},
"bouncedCount": {
"type": "integer",
"minimum": 0
},
"clickedCount": {
"type": "integer",
"minimum": 0
},
"engagedCount": {
"type": "integer",
"minimum": 0
},
"recipientCount": {
"type": "integer",
"minimum": 0
},
"complainedCount": {
"type": "integer",
"minimum": 0
},
"sentCountsByDay": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
},
"unsubscribedCount": {
"type": "integer",
"minimum": 0
},
"clickedSubscriberCount": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"AutomationUpdateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"definition": {
"$ref": "#/$defs/AutomationDefinition"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"required": [
"automation_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/AutomationUpdateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"automation_id": {
"type": "string",
"description": "The automation identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| automation_id* | string | The Automation identifier. |
{
"type": "object",
"$defs": {
"AutomationStatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"draft",
"running",
"paused"
],
"type": "string"
}
}
}
},
"required": [
"automation_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/AutomationStatusRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"automation_id": {
"type": "string",
"description": "The Automation identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| broadcast_id* | string | The broadcast identifier. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"AudienceCondition": {
"type": "object",
"required": [
"id",
"field",
"operator"
],
"properties": {
"id": {
"type": "string"
},
"field": {
"enum": [
"subscriber_status",
"country",
"segment",
"tag",
"sequence",
"form",
"custom_field",
"email_opened",
"email_unsubscribed",
"magic_link_clicked"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"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"
},
"customFieldId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AudienceDefinition": {
"type": "object",
"example": {
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
},
"examples": [
{
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
}
],
"required": [
"match",
"groups"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceConditionGroup"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"AudienceConditionGroup": {
"type": "object",
"required": [
"id",
"match",
"conditions"
],
"properties": {
"id": {
"type": "string"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCondition"
},
"minItems": 1
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"BroadcastUpsertRequest": {
"type": "object",
"required": [
"subject",
"body_document"
],
"properties": {
"subject": {
"type": "string",
"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."
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_opens": {
"type": "boolean"
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preview_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_clicks": {
"type": "boolean"
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"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"
}
]
},
"reply_to_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"audience_definition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/BroadcastUpsertRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}Returns a broadcast draft, scheduled send, active send, or completed send. Permission: broadcasts:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of items to return. |
| search | string | Filter Broadcasts by subject, preview text, status, or sender. |
| starting_after | string | Opaque cursor returned by the previous page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of items to return."
},
"search": {
"type": "string",
"maxLength": 200,
"description": "Filter Broadcasts by subject, preview text, status, or sender."
},
"starting_after": {
"type": "string",
"description": "Opaque cursor returned by the previous page."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"$defs": {
"BroadcastScheduleRequest": {
"type": "object",
"example": {
"scheduled_at": "2026-08-01T09:30:00.000Z"
},
"examples": [
{
"scheduled_at": "2026-08-01T09:30:00.000Z"
}
],
"required": [
"scheduled_at"
],
"properties": {
"scheduled_at": {
"type": "string",
"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)$",
"description": "A future date and time. Include an explicit UTC offset or Z suffix."
}
},
"additionalProperties": false
}
},
"required": [
"broadcast_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/BroadcastScheduleRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body | object | The exact JSON request body defined by the Mailrith public API contract. |
| broadcast_id* | string | The broadcast identifier. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"body": {
"type": "object",
"properties": {
"preflight_proof": {
"type": "string",
"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."
}
},
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| broadcast_id* | string | The broadcast identifier. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"BroadcastTestRequest": {
"type": "object",
"required": [
"recipient",
"subscriber_id"
],
"properties": {
"recipient": {
"type": "string",
"format": "email",
"description": "The inbox that receives the test message. It may differ from the saved Subscriber used for personalization."
},
"subscriber_id": {
"type": "string",
"description": "Required saved Subscriber ID whose profile supplies personalization. Use subscribers_list to find one before sending the test when needed."
}
},
"additionalProperties": false
}
},
"required": [
"broadcast_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/BroadcastTestRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"required": [
"broadcast_id"
],
"properties": {
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| broadcast_id* | string | The broadcast identifier. |
{
"type": "object",
"$defs": {
"AudienceCondition": {
"type": "object",
"required": [
"id",
"field",
"operator"
],
"properties": {
"id": {
"type": "string"
},
"field": {
"enum": [
"subscriber_status",
"country",
"segment",
"tag",
"sequence",
"form",
"custom_field",
"email_opened",
"email_unsubscribed",
"magic_link_clicked"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"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"
},
"customFieldId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AudienceDefinition": {
"type": "object",
"example": {
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
},
"examples": [
{
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
}
],
"required": [
"match",
"groups"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceConditionGroup"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"AudienceConditionGroup": {
"type": "object",
"required": [
"id",
"match",
"conditions"
],
"properties": {
"id": {
"type": "string"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCondition"
},
"minItems": 1
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"BroadcastUpdateRequest": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"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."
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_opens": {
"type": "boolean"
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preview_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_clicks": {
"type": "boolean"
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"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"
}
]
},
"reply_to_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"audience_definition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"required": [
"broadcast_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/BroadcastUpdateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"broadcast_id": {
"type": "string",
"description": "The broadcast identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| custom_field_id* | string | The custom field identifier. |
{
"type": "object",
"required": [
"custom_field_id"
],
"properties": {
"custom_field_id": {
"type": "string",
"description": "The custom field identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of custom fields to return. |
| search | string | Filter custom fields by label or type. |
| starting_after | string | Use the opaque cursor from the previous page to request the next page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of custom fields to return."
},
"search": {
"type": "string",
"maxLength": 200,
"description": "Filter custom fields by label or type."
},
"starting_after": {
"type": "string",
"description": "Use the opaque cursor from the previous page to request the next page."
}
},
"additionalProperties": false
}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.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"EmailTemplateUpsertRequest": {
"type": "object",
"anyOf": [
{
"required": [
"body_document"
]
},
{
"required": [
"starting_point_id"
]
}
],
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"enabled": {
"type": "boolean"
},
"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."
},
"starting_point_id": {
"type": "string",
"description": "Creates the email template from this canonical starting point. Do not also provide body_document."
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/EmailTemplateUpsertRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}Returns a reusable email template linked to the authenticated workspace. Permission: email_templates:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| template_id* | string | The email template identifier. |
{
"type": "object",
"required": [
"template_id"
],
"properties": {
"template_id": {
"type": "string",
"description": "The email template identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of items to return. |
| search | string | Filter email templates by name. |
| starting_after | string | Opaque cursor returned by the previous page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of items to return."
},
"search": {
"type": "string",
"maxLength": 200,
"description": "Filter email templates by name."
},
"starting_after": {
"type": "string",
"description": "Opaque cursor returned by the previous page."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| template_id* | string | The email template identifier. |
{
"type": "object",
"$defs": {
"SubscriberPreviewRequest": {
"type": "object",
"required": [
"subscriber_id"
],
"properties": {
"subscriber_id": {
"type": "string",
"description": "The saved Subscriber whose name, email, and custom fields should be used for personalization."
}
},
"additionalProperties": false
}
},
"required": [
"template_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SubscriberPreviewRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"template_id": {
"type": "string",
"description": "The email template identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| template_id* | string | The email template identifier. |
{
"type": "object",
"$defs": {
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
},
"EmailTemplateUpdateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 160
},
"enabled": {
"type": "boolean"
},
"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."
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"required": [
"template_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/EmailTemplateUpdateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"template_id": {
"type": "string",
"description": "The email template identifier."
}
},
"additionalProperties": false
}Returns one saved segment from the authenticated workspace. Permission: segments:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| segment_id* | string | The identifier of the segment to return. |
{
"type": "object",
"required": [
"segment_id"
],
"properties": {
"segment_id": {
"type": "string",
"description": "The identifier of the segment to return."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | The maximum number of segments to return. |
| search | string | Filter Segments by name or description. |
| starting_after | string | The opaque cursor from the previous page of saved segments. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "The maximum number of segments to return."
},
"search": {
"type": "string",
"maxLength": 200,
"description": "Filter Segments by name or description."
},
"starting_after": {
"type": "string",
"description": "The opaque cursor from the previous page of saved segments."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
{
"type": "object",
"$defs": {
"AudienceCondition": {
"type": "object",
"required": [
"id",
"field",
"operator"
],
"properties": {
"id": {
"type": "string"
},
"field": {
"enum": [
"subscriber_status",
"country",
"segment",
"tag",
"sequence",
"form",
"custom_field",
"email_opened",
"email_unsubscribed",
"magic_link_clicked"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"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"
},
"customFieldId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AudienceDefinition": {
"type": "object",
"example": {
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
},
"examples": [
{
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
}
],
"required": [
"match",
"groups"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceConditionGroup"
}
}
},
"additionalProperties": false
},
"SegmentPreviewRequest": {
"type": "object",
"required": [
"definition"
],
"properties": {
"definition": {
"allOf": [
{
"$ref": "#/$defs/AudienceDefinition"
}
],
"description": "The segment filters to preview. Include at least one filter group."
},
"current_segment_id": {
"anyOf": [
{
"type": "string",
"description": "When previewing an edit to an existing segment, include that segment id so Mailrith can catch circular segment references before saving."
},
{
"type": "null"
}
]
}
}
},
"AudienceConditionGroup": {
"type": "object",
"required": [
"id",
"match",
"conditions"
],
"properties": {
"id": {
"type": "string"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCondition"
},
"minItems": 1
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SegmentPreviewRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| sender_identity_id* | string | The sender identity identifier. |
{
"type": "object",
"required": [
"sender_identity_id"
],
"properties": {
"sender_identity_id": {
"type": "string",
"description": "The sender identity identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of sender identities to return. |
| starting_after | string | Opaque next_cursor returned by the previous sender identity page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of sender identities to return."
},
"starting_after": {
"type": "string",
"description": "Opaque next_cursor returned by the previous sender identity page."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"SequenceEmail": {
"type": "object",
"required": [
"id",
"subject",
"previewText",
"bodyDocument",
"status",
"delayValue",
"delayUnit",
"sendOnWeekdays"
],
"properties": {
"id": {
"type": "string"
},
"stats": {
"$ref": "#/$defs/EmailEngagementStats"
},
"status": {
"enum": [
"Draft",
"Published"
],
"type": "string"
},
"subject": {
"type": "string",
"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."
},
"delayUnit": {
"enum": [
"minute",
"hour",
"day"
],
"type": "string"
},
"delayValue": {
"type": "number",
"minimum": 0
},
"previewText": {
"type": [
"string",
"null"
]
},
"audienceMode": {
"enum": [
"all",
"include",
"exclude"
],
"type": "string"
},
"bodyDocument": {
"$ref": "#/$defs/BroadcastEmailDocument"
},
"sendOnWeekdays": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"uniqueItems": true
},
"audienceDefinition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"AudienceCondition": {
"type": "object",
"required": [
"id",
"field",
"operator"
],
"properties": {
"id": {
"type": "string"
},
"field": {
"enum": [
"subscriber_status",
"country",
"segment",
"tag",
"sequence",
"form",
"custom_field",
"email_opened",
"email_unsubscribed",
"magic_link_clicked"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"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"
},
"customFieldId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AudienceDefinition": {
"type": "object",
"example": {
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
},
"examples": [
{
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
}
],
"required": [
"match",
"groups"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceConditionGroup"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"SequenceDefinition": {
"type": "object",
"example": {
"emails": [
{
"id": "welcome",
"status": "Published",
"subject": "Welcome",
"delayUnit": "day",
"delayValue": 0,
"previewText": "Thanks for joining",
"audienceMode": "all",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to the newsletter.",
"type": "text"
}
]
}
]
},
"sendOnWeekdays": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
],
"audienceDefinition": null
}
]
},
"examples": [
{
"emails": [
{
"id": "welcome",
"status": "Published",
"subject": "Welcome",
"delayUnit": "day",
"delayValue": 0,
"previewText": "Thanks for joining",
"audienceMode": "all",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to the newsletter.",
"type": "text"
}
]
}
]
},
"sendOnWeekdays": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
],
"audienceDefinition": null
}
]
}
],
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"$ref": "#/$defs/SequenceEmail"
}
},
"sendOnWeekdays": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"uniqueItems": true
},
"defaultTemplateId": {
"type": [
"string",
"null"
]
},
"excludeAudienceDefinition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
},
"sendNewEmailsToCompletedSubscribers": {
"type": "boolean"
},
"restartSequenceForCompletedSubscribers": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EmailEngagementStats": {
"type": "object",
"required": [
"recipientCount",
"openedCount",
"clickedCount",
"unsubscribedCount"
],
"properties": {
"openedCount": {
"type": "integer",
"minimum": 0
},
"bouncedCount": {
"type": "integer",
"minimum": 0
},
"clickedCount": {
"type": "integer",
"minimum": 0
},
"engagedCount": {
"type": "integer",
"minimum": 0
},
"recipientCount": {
"type": "integer",
"minimum": 0
},
"complainedCount": {
"type": "integer",
"minimum": 0
},
"sentCountsByDay": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
},
"unsubscribedCount": {
"type": "integer",
"minimum": 0
},
"clickedSubscriberCount": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"SequenceUpsertRequest": {
"type": "object",
"required": [
"name",
"definition"
],
"properties": {
"name": {
"type": "string"
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"definition": {
"$ref": "#/$defs/SequenceDefinition"
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_opens": {
"type": "boolean"
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_clicks": {
"type": "boolean"
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connection_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reply_to_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"AudienceConditionGroup": {
"type": "object",
"required": [
"id",
"match",
"conditions"
],
"properties": {
"id": {
"type": "string"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCondition"
},
"minItems": 1
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SequenceUpsertRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}Returns one sequence from the authenticated workspace. Permission: sequences:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| sequence_id* | string | The sequence identifier. |
{
"type": "object",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The sequence identifier."
}
},
"additionalProperties": false
}Returns sequences in the authenticated workspace. Permission: sequences:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of sequences to return. |
| search | string | Filter sequences by name, status, or sender details. Retrieve a known Sequence ID through the item endpoint. |
| starting_after | string | Use the opaque cursor from the previous page to request the next page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of sequences to return."
},
"search": {
"type": "string",
"description": "Filter sequences by name, status, or sender details. Retrieve a known Sequence ID through the item endpoint."
},
"starting_after": {
"type": "string",
"description": "Use the opaque cursor from the previous page to request the next page."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| sequence_id* | string | The Sequence identifier. |
{
"type": "object",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The Sequence identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| sequence_id* | string | The Sequence identifier. |
| subscriber_id* | string | The saved Subscriber whose personalization and targeting should be previewed. |
{
"type": "object",
"required": [
"sequence_id",
"subscriber_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The Sequence identifier."
},
"subscriber_id": {
"type": "string",
"description": "The saved Subscriber whose personalization and targeting should be previewed."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| sequence_id* | string | The Sequence identifier. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"WorkflowTestRequest": {
"type": "object",
"required": [
"recipient",
"subscriber_id"
],
"properties": {
"recipient": {
"type": "string",
"format": "email"
},
"message_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 5,
"description": "Optional Sequence email IDs or Automation step IDs. Omit to test the first five available messages.",
"uniqueItems": true
},
"subscriber_id": {
"type": "string",
"description": "The saved Subscriber whose personalization should be rendered in every test message."
}
},
"additionalProperties": false
}
},
"required": [
"sequence_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/WorkflowTestRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"sequence_id": {
"type": "string",
"description": "The Sequence identifier."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| sequence_id* | string | The sequence identifier. |
{
"type": "object",
"$defs": {
"SequenceEmail": {
"type": "object",
"required": [
"id",
"subject",
"previewText",
"bodyDocument",
"status",
"delayValue",
"delayUnit",
"sendOnWeekdays"
],
"properties": {
"id": {
"type": "string"
},
"stats": {
"$ref": "#/$defs/EmailEngagementStats"
},
"status": {
"enum": [
"Draft",
"Published"
],
"type": "string"
},
"subject": {
"type": "string",
"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."
},
"delayUnit": {
"enum": [
"minute",
"hour",
"day"
],
"type": "string"
},
"delayValue": {
"type": "number",
"minimum": 0
},
"previewText": {
"type": [
"string",
"null"
]
},
"audienceMode": {
"enum": [
"all",
"include",
"exclude"
],
"type": "string"
},
"bodyDocument": {
"$ref": "#/$defs/BroadcastEmailDocument"
},
"sendOnWeekdays": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"uniqueItems": true
},
"audienceDefinition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"AudienceCondition": {
"type": "object",
"required": [
"id",
"field",
"operator"
],
"properties": {
"id": {
"type": "string"
},
"field": {
"enum": [
"subscriber_status",
"country",
"segment",
"tag",
"sequence",
"form",
"custom_field",
"email_opened",
"email_unsubscribed",
"magic_link_clicked"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"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"
},
"customFieldId": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"AudienceDefinition": {
"type": "object",
"example": {
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
},
"examples": [
{
"match": "all",
"groups": [
{
"id": "active-subscribers",
"match": "all",
"conditions": [
{
"id": "active-status",
"field": "subscriber_status",
"value": [
"Active"
],
"operator": "is"
}
]
}
]
}
],
"required": [
"match",
"groups"
],
"properties": {
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceConditionGroup"
}
}
},
"additionalProperties": false
},
"BroadcastEmailMark": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"bold",
"italic",
"strike",
"underline",
"link",
"textStyle",
"highlight"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"color": {
"type": "string"
},
"fontSize": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"BroadcastEmailNode": {
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string"
},
"type": {
"enum": [
"doc",
"paragraph",
"heading",
"text",
"hardBreak",
"bulletList",
"orderedList",
"listItem",
"blockquote",
"emailSection",
"emailSectionColumn",
"emailButton",
"image",
"horizontalRule"
],
"type": "string"
},
"attrs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"alt": {
"type": "string"
},
"src": {
"type": "string"
},
"crop": {
"enum": [
"none",
"square",
"circle"
],
"type": "string"
},
"href": {
"type": "string"
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string"
},
"align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"label": {
"type": "string"
},
"level": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"title": {
"type": "string"
},
"width": {
"enum": [
"default",
"large",
"full",
"fit"
],
"type": "string"
},
"margin": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"source": {
"enum": [
"unsplash"
],
"type": "string"
},
"caption": {
"type": "string"
},
"columns": {
"enum": [
1,
2,
3
],
"type": "integer"
},
"padding": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"unsplash": {
"type": "object",
"required": [
"photographerName"
],
"properties": {
"photoId": {
"type": "string"
},
"unsplashUrl": {
"type": "string"
},
"photographerUrl": {
"type": "string"
},
"photographerName": {
"type": "string"
},
"photographerUsername": {
"type": "string"
}
},
"additionalProperties": false
},
"linkColor": {
"type": "string"
},
"textAlign": {
"enum": [
"left",
"center",
"right",
"justify"
],
"type": "string"
},
"textColor": {
"type": "string"
},
"fillColumn": {
"type": "boolean"
},
"borderColor": {
"type": "string"
},
"borderWidth": {
"enum": [
"none",
"normal",
"large"
],
"type": "string"
},
"borderRadius": {
"enum": [
"none",
"normal",
"small",
"large",
"full"
],
"type": "string"
},
"widthPercent": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"verticalAlign": {
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"layoutAlignment": {
"enum": [
"left",
"center"
],
"type": "string"
},
"backgroundImageUrl": {
"type": "string"
},
"blockquoteBorderColor": {
"type": "string"
}
},
"additionalProperties": false
},
"marks": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailMark"
}
},
"content": {
"type": "array",
"items": {
"$ref": "#/$defs/BroadcastEmailNode"
}
}
},
"additionalProperties": false
},
"SequenceDefinition": {
"type": "object",
"example": {
"emails": [
{
"id": "welcome",
"status": "Published",
"subject": "Welcome",
"delayUnit": "day",
"delayValue": 0,
"previewText": "Thanks for joining",
"audienceMode": "all",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to the newsletter.",
"type": "text"
}
]
}
]
},
"sendOnWeekdays": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
],
"audienceDefinition": null
}
]
},
"examples": [
{
"emails": [
{
"id": "welcome",
"status": "Published",
"subject": "Welcome",
"delayUnit": "day",
"delayValue": 0,
"previewText": "Thanks for joining",
"audienceMode": "all",
"bodyDocument": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Welcome to the newsletter.",
"type": "text"
}
]
}
]
},
"sendOnWeekdays": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
],
"audienceDefinition": null
}
]
}
],
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"$ref": "#/$defs/SequenceEmail"
}
},
"sendOnWeekdays": {
"type": "array",
"items": {
"enum": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri",
"Sat",
"Sun"
],
"type": "string"
},
"uniqueItems": true
},
"defaultTemplateId": {
"type": [
"string",
"null"
]
},
"excludeAudienceDefinition": {
"anyOf": [
{
"$ref": "#/$defs/AudienceDefinition"
},
{
"type": "null"
}
]
},
"sendNewEmailsToCompletedSubscribers": {
"type": "boolean"
},
"restartSequenceForCompletedSubscribers": {
"type": "boolean"
}
},
"additionalProperties": false
},
"EmailEngagementStats": {
"type": "object",
"required": [
"recipientCount",
"openedCount",
"clickedCount",
"unsubscribedCount"
],
"properties": {
"openedCount": {
"type": "integer",
"minimum": 0
},
"bouncedCount": {
"type": "integer",
"minimum": 0
},
"clickedCount": {
"type": "integer",
"minimum": 0
},
"engagedCount": {
"type": "integer",
"minimum": 0
},
"recipientCount": {
"type": "integer",
"minimum": 0
},
"complainedCount": {
"type": "integer",
"minimum": 0
},
"sentCountsByDay": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0
}
},
"unsubscribedCount": {
"type": "integer",
"minimum": 0
},
"clickedSubscriberCount": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"SequenceUpdateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"definition": {
"$ref": "#/$defs/SequenceDefinition"
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_opens": {
"type": "boolean"
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"track_clicks": {
"type": "boolean"
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"connection_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"reply_to_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"minProperties": 1,
"additionalProperties": false
},
"AudienceConditionGroup": {
"type": "object",
"required": [
"id",
"match",
"conditions"
],
"properties": {
"id": {
"type": "string"
},
"match": {
"enum": [
"all",
"any"
],
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCondition"
},
"minItems": 1
}
},
"additionalProperties": false
},
"BroadcastEmailDocument": {
"allOf": [
{
"$ref": "#/$defs/BroadcastEmailNode"
}
],
"example": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
},
"examples": [
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"text": "Hello [Subscriber_Name, fallback=\"friend\"].",
"type": "text"
}
]
}
]
}
],
"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."
}
},
"required": [
"sequence_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SequenceUpdateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"sequence_id": {
"type": "string",
"description": "The sequence identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| sequence_id* | string | The Sequence identifier. |
{
"type": "object",
"$defs": {
"SequenceStatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"running",
"paused"
],
"type": "string"
}
}
}
},
"required": [
"sequence_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SequenceStatusRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"sequence_id": {
"type": "string",
"description": "The Sequence identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| tag_id* | string | The Tag identifier. |
| subscriber_id* | string | The Subscriber identifier. |
{
"type": "object",
"required": [
"subscriber_id",
"tag_id"
],
"properties": {
"tag_id": {
"type": "string",
"description": "The Tag identifier."
},
"subscriber_id": {
"type": "string",
"description": "The Subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| sequence_id* | string | The sequence identifier. |
| subscriber_id* | string | The subscriber identifier. |
{
"type": "object",
"required": [
"subscriber_id",
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The sequence identifier."
},
"subscriber_id": {
"type": "string",
"description": "The subscriber identifier."
}
},
"additionalProperties": false
}Returns one Subscriber by its stable identifier from the authenticated workspace. Permission: subscribers:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| subscriber_id* | string | The Subscriber identifier. |
{
"type": "object",
"required": [
"subscriber_id"
],
"properties": {
"subscriber_id": {
"type": "string",
"description": "The Subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| string | Filter subscribers by an exact subscriber email address. | |
| limit | integer | Maximum number of subscribers to return. Defaults to 25 and is capped at 100. |
| search | string | Filter subscribers by name, email, or status. |
| status | string | Filter subscribers by subscriber status. |
| tag_id | string | Return subscribers that currently have this tag ID. Repeat `tag_id` or use `tag_ids` to match any of several tags. |
| tag_ids | string | Comma-separated tag IDs. By default, the API returns subscribers who have any listed tag. |
| cold_only | boolean | When `true`, return only cold subscribers. |
| sequence_id | string | Return subscribers that match this sequence ID. Repeat `sequence_id` or use `sequence_ids` to match any of several sequences. |
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.
| Argument | Type | Description |
|---|---|---|
| sequence_id* | string | The sequence identifier. |
| subscriber_id* | string | The subscriber identifier. |
{
"type": "object",
"required": [
"subscriber_id",
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The sequence identifier."
},
"subscriber_id": {
"type": "string",
"description": "The subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| tag_id* | string | The tag identifier. |
| subscriber_id* | string | The subscriber identifier. |
{
"type": "object",
"required": [
"subscriber_id",
"tag_id"
],
"properties": {
"tag_id": {
"type": "string",
"description": "The tag identifier."
},
"subscriber_id": {
"type": "string",
"description": "The subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| subscriber_id* | string | The subscriber identifier. |
{
"type": "object",
"$defs": {
"SubscriberUpdateRequest": {
"type": "object",
"example": {
"name": "Ada Lovelace",
"country": "DE",
"custom_fields": {
"cf_company": "Analytical Engines"
}
},
"examples": [
{
"name": "Ada Lovelace",
"country": "DE",
"custom_fields": {
"cf_company": "Analytical Engines"
}
}
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"country": {
"anyOf": [
{
"type": "string",
"description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code."
},
{
"type": "null"
}
]
},
"custom_fields": {
"type": "object",
"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.",
"additionalProperties": true
},
"subscribed_on": {
"type": "string",
"example": "2026-04-11",
"examples": [
"2026-04-11"
],
"description": "Subscriber-local subscription date in YYYY-MM-DD format."
}
}
}
},
"required": [
"subscriber_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SubscriberUpdateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"subscriber_id": {
"type": "string",
"description": "The subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| subscriber_id* | string | The Subscriber identifier. |
{
"type": "object",
"$defs": {
"ConsentEvidence": {
"type": "object",
"required": [
"lawful_basis",
"collected_at",
"evidence_reference"
],
"properties": {
"source_url": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"collected_at": {
"type": "string",
"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)$",
"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."
},
"lawful_basis": {
"type": "string",
"maxLength": 64
},
"evidence_reference": {
"type": "string",
"maxLength": 512
},
"consent_text_version": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
]
},
"technical_evidence_hash": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
{
"type": "null"
}
]
}
},
"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.",
"additionalProperties": false
},
"SubscriberStatusRequest": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"Active",
"Unconfirmed",
"Unsubscribed",
"Complained",
"Bounced",
"Blocked"
],
"type": "string"
},
"consent_evidence": {
"$ref": "#/$defs/ConsentEvidence"
}
}
}
},
"required": [
"subscriber_id",
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SubscriberStatusRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"subscriber_id": {
"type": "string",
"description": "The Subscriber identifier."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"ConsentEvidence": {
"type": "object",
"required": [
"lawful_basis",
"collected_at",
"evidence_reference"
],
"properties": {
"source_url": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 2048
},
{
"type": "null"
}
]
},
"collected_at": {
"type": "string",
"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)$",
"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."
},
"lawful_basis": {
"type": "string",
"maxLength": 64
},
"evidence_reference": {
"type": "string",
"maxLength": 512
},
"consent_text_version": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
]
},
"technical_evidence_hash": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
{
"type": "null"
}
]
}
},
"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.",
"additionalProperties": false
},
"SubscriberUpsertRequest": {
"type": "object",
"example": {
"name": "Ada Lovelace",
"email": "[email protected]",
"status": "Unconfirmed",
"country": "DE",
"custom_fields": {
"cf_company": "Analytical Engines"
}
},
"examples": [
{
"name": "Ada Lovelace",
"email": "[email protected]",
"status": "Unconfirmed",
"country": "DE",
"custom_fields": {
"cf_company": "Analytical Engines"
}
}
],
"required": [
"email"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"status": {
"enum": [
"Active",
"Unconfirmed",
"Unsubscribed",
"Complained",
"Bounced",
"Blocked"
],
"type": "string"
},
"country": {
"anyOf": [
{
"type": "string",
"description": "Two-letter country code or country name. Mailrith stores Subscriber country as a two-letter country code."
},
{
"type": "null"
}
]
},
"create_only": {
"type": "boolean",
"description": "When true, Mailrith returns a 409 conflict instead of updating an existing subscriber with the same email."
},
"custom_fields": {
"type": "object",
"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.",
"additionalProperties": true
},
"subscribed_on": {
"type": "string",
"example": "2026-04-11",
"examples": [
"2026-04-11"
],
"description": "Subscriber-local subscription date in YYYY-MM-DD format."
},
"consent_evidence": {
"$ref": "#/$defs/ConsentEvidence"
}
}
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/SubscriberUpsertRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| body* | object | The exact JSON request body defined by the Mailrith public API contract. |
| idempotency_key | string | Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes. |
{
"type": "object",
"$defs": {
"TagCreateRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Tag name to create. You can also create the GDPR consent tag names when you need to apply consent collected outside Mailrith."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"properties": {
"body": {
"$ref": "#/$defs/TagCreateRequest",
"type": "object",
"description": "The exact JSON request body defined by the Mailrith public API contract."
},
"idempotency_key": {
"type": "string",
"maxLength": 256,
"description": "Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes."
}
},
"additionalProperties": false
}Returns one Tag from the authenticated workspace. Permission: tags:read. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| tag_id* | string | The Tag identifier. |
{
"type": "object",
"required": [
"tag_id"
],
"properties": {
"tag_id": {
"type": "string",
"description": "The Tag identifier."
}
},
"additionalProperties": false
}Returns tags in the authenticated workspace. Permission: tags:read. Pagination: use bounded pages and returned cursors. API reference: https://mailrith.com/developers/api-reference.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of tags to return. |
| search | string | Filter Tags by name or description. Retrieve a known Tag ID through the item endpoint. |
| starting_after | string | Use the opaque cursor from the previous page to request the next page. |
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of tags to return."
},
"search": {
"type": "string",
"description": "Filter Tags by name or description. Retrieve a known Tag ID through the item endpoint."
},
"starting_after": {
"type": "string",
"description": "Use the opaque cursor from the previous page to request the next page."
}
},
"additionalProperties": false
}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.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}| sequence_ids | string | Comma-separated sequence IDs. By default, the API returns only subscribers who are active in any listed sequence. |
| tag_operator | string | Controls how tag filters are applied. Defaults to `has_any_of`. |
| starting_after | string | Use the opaque cursor from the previous page to request the next page. |
| sequence_operator | string | Controls how sequence filters are applied. Defaults to `is_active_in_any_of`. |
{
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "Filter subscribers by an exact subscriber email address."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Maximum number of subscribers to return. Defaults to 25 and is capped at 100."
},
"search": {
"type": "string",
"description": "Filter subscribers by name, email, or status."
},
"status": {
"enum": [
"Active",
"Unconfirmed",
"Unsubscribed",
"Complained",
"Bounced",
"Blocked"
],
"type": "string",
"description": "Filter subscribers by subscriber status."
},
"tag_id": {
"type": "string",
"description": "Return subscribers that currently have this tag ID. Repeat `tag_id` or use `tag_ids` to match any of several tags."
},
"tag_ids": {
"type": "string",
"description": "Comma-separated tag IDs. By default, the API returns subscribers who have any listed tag."
},
"cold_only": {
"type": "boolean",
"description": "When `true`, return only cold subscribers."
},
"sequence_id": {
"type": "string",
"description": "Return subscribers that match this sequence ID. Repeat `sequence_id` or use `sequence_ids` to match any of several sequences."
},
"sequence_ids": {
"type": "string",
"description": "Comma-separated sequence IDs. By default, the API returns only subscribers who are active in any listed sequence."
},
"tag_operator": {
"enum": [
"has_any_of",
"has_none_of"
],
"type": "string",
"default": "has_any_of",
"description": "Controls how tag filters are applied. Defaults to `has_any_of`."
},
"starting_after": {
"type": "string",
"description": "Use the opaque cursor from the previous page to request the next page."
},
"sequence_operator": {
"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",
"default": "is_active_in_any_of",
"description": "Controls how sequence filters are applied. Defaults to `is_active_in_any_of`."
}
},
"additionalProperties": false
}