Runearc is an MCP server published by io.github.runearc-labs, hosted at mcp.runearc.com. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 90 tools, including activate_sequence, add_contact, add_domain, add_to_list, bulk_contacts.
Email inboxes for AI agents: create an inbox, wait for the verification code, send and reply.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Activate a draft or paused sequence so triggers enrol contacts and due steps run. Returns the sequence with status "active". Errors: sequence_empty, from_required (set a From address with a sender on a verified domain), invalid_branch, sequence_not_found. Next: enroll_contact_in_sequence to start one contact now, or wait for the trigger.
| Parameter | Type | Description |
|---|---|---|
| sequence_id * | string | Sequence id, such as "seq_01j9...", from list_sequences or create_sequence. |
{
"name": "activate_sequence",
"title": "Activate sequence",
"description": "Activate a draft or paused sequence so triggers enrol contacts and due steps run. Returns the sequence with status \"active\". Errors: sequence_empty, from_required (set a From address with a sender on a verified domain), invalid_branch, sequence_not_found. Next: enroll_contact_in_sequence to start one contact now, or wait for the trigger.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence."
}
}
},
"annotations": {
"title": "Activate sequence",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Add ONE new contact (a person to email) to the workspace's audience; tags and list_ids given here are applied at once (missing tags are created). Use update_contact to change an existing contact, import_contacts or bulk_contacts for many. Returns the contact {id, email, status, tags, list_ids, ...}. Errors: invalid_email, contact_exists (use update_contact instead), unknown_field, not_found (list). Next: track_event for this contact, or enroll_contact_in_sequence.
| Parameter | Type | Description |
|---|---|---|
| tags | array | Tags to attach; created when missing. |
| email * | string | The contact's email address. |
| source | ["string","null"] | Where they came from, such as "signup" or "import". |
| list_ids | array | Ids (lst_...) of lists to join. |
| last_name | ["string","null"] | |
| first_name | ["string","null"] | |
| revenue_cents | ["integer","null"] | Lifetime revenue in cents. |
{
"name": "add_contact",
"title": "Add contact",
"description": "Add ONE new contact (a person to email) to the workspace's audience; tags and list_ids given here are applied at once (missing tags are created). Use update_contact to change an existing contact, import_contacts or bulk_contacts for many. Returns the contact {id, email, status, tags, list_ids, ...}. Errors: invalid_email, contact_exists (use update_contact instead), unknown_field, not_found (list). Next: track_event for this contact, or enroll_contact_in_sequence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Tags to attach; created when missing."
},
"email": {
"type": "string",
"description": "The contact's email address."
},
"source": {
"type": [
"string",
"null"
],
"description": "Where they came from, such as \"signup\" or \"import\"."
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Ids (lst_...) of lists to join."
},
"last_name": {
"type": [
"string",
"null"
]
},
"first_name": {
"type": [
"string",
"null"
]
},
"revenue_cents": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Lifetime revenue in cents."
}
}
},
"annotations": {
"title": "Add contact",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Add a custom domain to send and receive mail on, such as acme.com. Returns {id, name, status, provider, can_auto_configure, records: [{type, name, value, priority, required, status, fix}], next_step, existing_mx?}. Publish every required record at the DNS host. existing_mx means the domain already gets mail elsewhere: adding our MX moves it, so prefer a subdomain such as mail.acme.com. Errors: invalid_domain, reserved_domain, domain_exists, domain_taken, insufficient_scope. Next: publish the records, then call verify_domain; then create_inbox with domain set to it.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Domain name to send and receive on, such as "acme.com" or "mail.acme.com". |
{
"name": "add_domain",
"title": "Add sending domain",
"description": "Add a custom domain to send and receive mail on, such as acme.com. Returns {id, name, status, provider, can_auto_configure, records: [{type, name, value, priority, required, status, fix}], next_step, existing_mx?}. Publish every required record at the DNS host. existing_mx means the domain already gets mail elsewhere: adding our MX moves it, so prefer a subdomain such as mail.acme.com. Errors: invalid_domain, reserved_domain, domain_exists, domain_taken, insufficient_scope. Next: publish the records, then call verify_domain; then create_inbox with domain set to it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Domain name to send and receive on, such as \"acme.com\" or \"mail.acme.com\"."
}
}
},
"annotations": {
"title": "Add sending domain",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Add contacts to a list. Returns {added: n} for newly added contacts. Errors: not_found (list or contact). Next: list_contacts with list_id to see members.
| Parameter | Type | Description |
|---|---|---|
| emails * | array | Emails or ids (ctc_...) of existing contacts. |
| list_id * | string | List id (lst_...). |
{
"name": "add_to_list",
"title": "Add contacts to list",
"description": "Add contacts to a list. Returns {added: n} for newly added contacts. Errors: not_found (list or contact). Next: list_contacts with list_id to see members.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"list_id",
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Emails or ids (ctc_...) of existing contacts."
},
"list_id": {
"type": "string",
"description": "List id (lst_...)."
}
}
},
"annotations": {
"title": "Add contacts to list",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Tag, add to a list, unsubscribe or delete many contacts at once. Give exactly one of contact_ids, emails or all_matching. Returns the operation {id, status, total, ...}; it runs in the background. Errors: invalid_body, too_many_targets, invalid_tags, empty_selection, not_found (list). Next: unsubscribe_contacts for plain unsubscribes; list_suppressions to review who is blocked.
| Parameter | Type | Description |
|---|---|---|
| tags | array | For "tag": the tags to add. |
| action * | string | "tag", "add_to_list", "unsubscribe" or "delete". |
| emails | ["array","null"] | Email addresses of contacts. |
| list_id | ["string","null"] | For "add_to_list": the list id (lst_...). |
| contact_ids | ["array","null"] | Contact ids (ctc_...). Give exactly one of contact_ids, emails or all_matching. |
| all_matching | any | Act on every contact matching this filter {q, status, tag, list_id}; {} means all contacts. |
{
"name": "bulk_contacts",
"title": "Bulk update contacts",
"description": "Tag, add to a list, unsubscribe or delete many contacts at once. Give exactly one of contact_ids, emails or all_matching. Returns the operation {id, status, total, ...}; it runs in the background. Errors: invalid_body, too_many_targets, invalid_tags, empty_selection, not_found (list). Next: unsubscribe_contacts for plain unsubscribes; list_suppressions to review who is blocked.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"action"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "For \"tag\": the tags to add."
},
"action": {
"type": "string",
"description": "\"tag\", \"add_to_list\", \"unsubscribe\" or \"delete\"."
},
"emails": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"default": null,
"description": "Email addresses of contacts."
},
"list_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "For \"add_to_list\": the list id (lst_...)."
},
"contact_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"default": null,
"description": "Contact ids (ctc_...). Give exactly one of contact_ids, emails or all_matching."
},
"all_matching": {
"default": null,
"description": "Act on every contact matching this filter {q, status, tag, list_id}; {} means all contacts."
}
}
},
"annotations": {
"title": "Bulk update contacts",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Cancel a campaign that has not finished. Pending recipients are dropped; mail already sent is not recalled. Errors: campaign_not_cancelable. Next: list_campaigns.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
{
"name": "cancel_campaign",
"title": "Cancel campaign",
"description": "Cancel a campaign that has not finished. Pending recipients are dropped; mail already sent is not recalled. Errors: campaign_not_cancelable. Next: list_campaigns.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
}
}
},
"annotations": {
"title": "Cancel campaign",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Connect a billing provider so purchases, renewals, cancellations and refunds become events and contact revenue. Returns webhook_path (prefix with the API origin) to paste into the provider; `secret` is returned only if Runearc generated it (shown once). Errors: unknown_billing_provider, billing_already_connected. Next: send a test event from the provider, then list_billing_integrations to see last_event_at.
| Parameter | Type | Description |
|---|---|---|
| secret | ["string","null"] | The provider's webhook signing secret. Omit to have Runearc generate one. |
| provider * | string | stripe, paddle, lemonsqueezy, polar, revenuecat, adapty or shopify. |
{
"name": "connect_billing_integration",
"title": "Connect billing integration",
"description": "Connect a billing provider so purchases, renewals, cancellations and refunds become events and contact revenue. Returns webhook_path (prefix with the API origin) to paste into the provider; `secret` is returned only if Runearc generated it (shown once). Errors: unknown_billing_provider, billing_already_connected. Next: send a test event from the provider, then list_billing_integrations to see last_event_at.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"provider"
],
"properties": {
"secret": {
"type": [
"string",
"null"
],
"default": null,
"description": "The provider's webhook signing secret. Omit to have Runearc generate one."
},
"provider": {
"type": "string",
"description": "stripe, paddle, lemonsqueezy, polar, revenuecat, adapty or shopify."
}
}
},
"annotations": {
"title": "Connect billing integration",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a draft campaign, blank, from a design, or as a copy of another campaign. Returns the campaign {id, status:"draft", ...}. Errors: invalid_name, unknown_design, not_found. Next: update_campaign to set subject, from_address, document and audience, then send_campaign_test.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Campaign name, for example "November product update". |
| design | ["string","null"] | Optional design slug from list_campaign_designs. |
| copy_of | ["string","null"] | Optional campaign id (cmp_...) to copy. |
{
"name": "create_campaign",
"title": "Create campaign",
"description": "Create a draft campaign, blank, from a design, or as a copy of another campaign. Returns the campaign {id, status:\"draft\", ...}. Errors: invalid_name, unknown_design, not_found. Next: update_campaign to set subject, from_address, document and audience, then send_campaign_test.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Campaign name, for example \"November product update\"."
},
"design": {
"type": [
"string",
"null"
],
"default": null,
"description": "Optional design slug from list_campaign_designs."
},
"copy_of": {
"type": [
"string",
"null"
],
"default": null,
"description": "Optional campaign id (cmp_...) to copy."
}
}
},
"annotations": {
"title": "Create campaign",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Document a custom event so teammates know what it means. Returns the definition. Errors: event_definition_exists, invalid_event_name, reserved_event_name. Next: track_event to send it, or create_sync_rule.
| Parameter | Type | Description |
|---|---|---|
| name * | string | The event name, such as "plan_upgraded". |
| properties | any | Documentation of the properties: [{"name": "plan", "type": "string"}]. Not enforced. |
| description | ["string","null"] | What the event means. |
{
"name": "create_event_definition",
"title": "Create event definition",
"description": "Document a custom event so teammates know what it means. Returns the definition. Errors: event_definition_exists, invalid_event_name, reserved_event_name. Next: track_event to send it, or create_sync_rule.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The event name, such as \"plan_upgraded\"."
},
"properties": {
"default": null,
"description": "Documentation of the properties: [{\"name\": \"plan\", \"type\": \"string\"}]. Not enforced."
},
"description": {
"type": [
"string",
"null"
],
"default": null,
"description": "What the event means."
}
}
},
"annotations": {
"title": "Create event definition",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create an embeddable signup form from a template (newsletter, waitlist or product-updates). Returns the form with its id. Errors: unknown_template, invalid_form_config, unknown_form_field, invalid_origin, list_not_found. Next: put <div data-runearc-form="ID"></div> and the runearc-embed.js script on your site, or create_popup to show the form on a trigger.
| Parameter | Type | Description |
|---|---|---|
| name * | string | A name for the form, such as "Footer signup". |
| tags | array | Tag new contacts with these tags. |
| list_ids | array | Add new contacts to these lists (list ids). |
| template | ["string","null"] | Starting template: newsletter, waitlist or product-updates. Default newsletter. |
| double_opt_in | boolean | Send a confirmation email first (double opt-in). |
| allowed_origins | array | Websites allowed to submit, such as ["https://example.com"]. Empty means any. |
{
"name": "create_form",
"title": "Create signup form",
"description": "Create an embeddable signup form from a template (newsletter, waitlist or product-updates). Returns the form with its id. Errors: unknown_template, invalid_form_config, unknown_form_field, invalid_origin, list_not_found. Next: put <div data-runearc-form=\"ID\"></div> and the runearc-embed.js script on your site, or create_popup to show the form on a trigger.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the form, such as \"Footer signup\"."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Tag new contacts with these tags."
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Add new contacts to these lists (list ids)."
},
"template": {
"type": [
"string",
"null"
],
"default": null,
"description": "Starting template: newsletter, waitlist or product-updates. Default newsletter."
},
"double_opt_in": {
"type": "boolean",
"default": false,
"description": "Send a confirmation email first (double opt-in)."
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Websites allowed to submit, such as [\"https://example.com\"]. Empty means any."
}
}
},
"annotations": {
"title": "Create signup form",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a conversion goal. Each matching event records a conversion credited to the last email sent or clicked within window_days. Returns the goal. Errors: goal_exists, invalid_window (1 to 90), invalid_event_name. Next: track_event to convert, then goal_stats.
| Parameter | Type | Description |
|---|---|---|
| name * | string | A unique name, such as "Upgraded to pro". |
| conditions | any | Optional property conditions, same shape as for sync rules. |
| event_name * | string | The event that counts as a conversion. |
| window_days | ["integer","null"] | Attribution window in days, 1 to 90 (default 7): an email sent or clicked this long before gets the credit. |
| value_property | ["string","null"] | Property holding the revenue of the event, such as "amount". |
{
"name": "create_goal",
"title": "Create goal",
"description": "Create a conversion goal. Each matching event records a conversion credited to the last email sent or clicked within window_days. Returns the goal. Errors: goal_exists, invalid_window (1 to 90), invalid_event_name. Next: track_event to convert, then goal_stats.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"event_name"
],
"properties": {
"name": {
"type": "string",
"description": "A unique name, such as \"Upgraded to pro\"."
},
"conditions": {
"default": null,
"description": "Optional property conditions, same shape as for sync rules."
},
"event_name": {
"type": "string",
"description": "The event that counts as a conversion."
},
"window_days": {
"type": [
"integer",
"null"
],
"format": "int32",
"default": null,
"description": "Attribution window in days, 1 to 90 (default 7): an email sent or clicked this long before gets the credit."
},
"value_property": {
"type": [
"string",
"null"
],
"default": null,
"description": "Property holding the revenue of the event, such as \"amount\"."
}
}
},
"annotations": {
"title": "Create goal",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a new email inbox that can receive (and send) mail right away. Returns {id, address, display_name, created_at}. Errors: inbox_limit_reached (plan limit; delete an inbox or upgrade), inbox_exists (pick another name), invalid_local_part, domain_not_found (custom domain not added), insufficient_scope (key limited to one inbox). Next: give `address` to the service you are signing up for, then call wait_for_email with `id` (pass after = created_at so an email that arrives early is not missed).
| Parameter | Type | Description |
|---|---|---|
| name | ["string","null"] | The part before the @, such as "signup-bot". 1 to 64 letters, digits, dots, hyphens or underscores. Leave out for a random name like "inbox-k3x9q2". |
| domain | ["string","null"] | A custom domain this org added with add_domain, such as "acme.com". Leave out to use the free shared domain (<code>.runearc.email). |
| display_name | ["string","null"] | Name shown in the From header of mail sent from this inbox, such as "Acme Bot". |
{
"name": "create_inbox",
"title": "Create inbox",
"description": "Create a new email inbox that can receive (and send) mail right away. Returns {id, address, display_name, created_at}. Errors: inbox_limit_reached (plan limit; delete an inbox or upgrade), inbox_exists (pick another name), invalid_local_part, domain_not_found (custom domain not added), insufficient_scope (key limited to one inbox). Next: give `address` to the service you are signing up for, then call wait_for_email with `id` (pass after = created_at so an email that arrives early is not missed).",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": [
"string",
"null"
],
"default": null,
"description": "The part before the @, such as \"signup-bot\". 1 to 64 letters, digits, dots, hyphens\nor underscores. Leave out for a random name like \"inbox-k3x9q2\"."
},
"domain": {
"type": [
"string",
"null"
],
"default": null,
"description": "A custom domain this org added with add_domain, such as \"acme.com\". Leave out to use\nthe free shared domain (<code>.runearc.email)."
},
"display_name": {
"type": [
"string",
"null"
],
"default": null,
"description": "Name shown in the From header of mail sent from this inbox, such as \"Acme Bot\"."
}
}
},
"annotations": {
"title": "Create inbox",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create an empty, named contact list (a static group you add people to by hand; for rule-based groups use create_segment). Names are unique per workspace. Returns {id, name, description, member_count: 0}. Errors: list_exists (call list_lists and reuse it), invalid_name. Next: add_to_list with the returned id.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| description | ["string","null"] |
{
"name": "create_list",
"title": "Create contact list",
"description": "Create an empty, named contact list (a static group you add people to by hand; for rule-based groups use create_segment). Names are unique per workspace. Returns {id, name, description, member_count: 0}. Errors: list_exists (call list_lists and reuse it), invalid_name. Next: add_to_list with the returned id.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
}
}
},
"annotations": {
"title": "Create contact list",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a draft landing page from a template (blank, waitlist, product-launch, newsletter). Returns the page with its blocks. Errors: page_slug_taken, unknown_page_template, invalid_page_form. Next: update_page to edit blocks and pick a form, then publish_page.
| Parameter | Type | Description |
|---|---|---|
| name * | string | A name for the page, such as "Spring launch". |
| slug | ["string","null"] | URL slug (3 to 40 lowercase letters, digits, hyphens). Default: from the name. |
| form_id | ["string","null"] | The signup form (frm_...) the signup block uses. |
| template | ["string","null"] | Starting template: blank, waitlist, product-launch or newsletter. Default blank. |
{
"name": "create_page",
"title": "Create page",
"description": "Create a draft landing page from a template (blank, waitlist, product-launch, newsletter). Returns the page with its blocks. Errors: page_slug_taken, unknown_page_template, invalid_page_form. Next: update_page to edit blocks and pick a form, then publish_page.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the page, such as \"Spring launch\"."
},
"slug": {
"type": [
"string",
"null"
],
"default": null,
"description": "URL slug (3 to 40 lowercase letters, digits, hyphens). Default: from the name."
},
"form_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "The signup form (frm_...) the signup block uses."
},
"template": {
"type": [
"string",
"null"
],
"default": null,
"description": "Starting template: blank, waitlist, product-launch or newsletter. Default blank."
}
}
},
"annotations": {
"title": "Create page",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a popup that shows a form on a trigger (time, scroll or exit_intent), optionally only on some paths. Errors: invalid_popup_config, not_found (form), invalid_status. Next: set status live, then add the runearc-embed.js script with data-popup="ID" to your site; popup_stats shows conversions.
| Parameter | Type | Description |
|---|---|---|
| name * | string | A name for the popup, such as "Blog exit offer". |
| status | ["string","null"] | draft or live. Default draft. |
| form_id * | string | The form to show (frm_...). |
| heading * | string | The popup headline. |
| trigger | ["string","null"] | time, scroll or exit_intent. Default time. |
| only_paths | array | Only on URLs starting with these paths, such as ["/blog"]. Empty means every page. |
| days_between | ["integer","null"] | Days before showing again to the same visitor. Default 7. |
| trigger_value | ["integer","null"] | Seconds for time, percent for scroll. Default 5 and 50. |
Save a segment (a named audience filter over contacts). Returns the segment. Errors: invalid_filter (read the fix), segment_name_taken, segment_limit. Next: preview_segment, then use the id as the audience of a campaign.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Segment name, unique in the workspace. |
| filter * | any | The filter: {"type":"group","op":"and"|"or","children":[...]}. Conditions: {"type":"tag","tag":"vip","has":true}, {"type":"status","is":["active"]}, {"type":"list","list_id":"lst_..","member":true}, {"type":"field","field":"email|first_name|last_name|fields.<key>","op":"eq|ne|contains|starts_with|gt… |
| description | string | What it is for. |
{
"name": "create_segment",
"title": "Create segment",
"description": "Save a segment (a named audience filter over contacts). Returns the segment. Errors: invalid_filter (read the fix), segment_name_taken, segment_limit. Next: preview_segment, then use the id as the audience of a campaign.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"filter"
],
"properties": {
"name": {
"type": "string",
"description": "Segment name, unique in the workspace."
},
"filter": {
"description": "The filter: {\"type\":\"group\",\"op\":\"and\"|\"or\",\"children\":[...]}. Conditions: {\"type\":\"tag\",\"tag\":\"vip\",\"has\":true},\n{\"type\":\"status\",\"is\":[\"active\"]}, {\"type\":\"list\",\"list_id\":\"lst_..\",\"member\":true},\n{\"type\":\"field\",\"field\":\"email|first_name|last_name|fields.<key>\",\"op\":\"eq|ne|contains|starts_with|gt|gte|lt|lte|is_set|is_not_set\",\"value\":\"..\"},\n{\"type\":\"engagement\",\"action\":\"sent|opened|clicked|engaged\",\"within_days\":30,\"min_count\":1,\"negate\":false},\n{\"type\":\"event\",\"name\":\"..\",\"within_days\":14}, {\"type\":\"date\",\"field\":\"created_at\",\"op\":\"within_last_days|older_than_days|before|after\",\"days\":7}."
},
"description": {
"type": "string",
"default": "",
"description": "What it is for."
}
}
},
"annotations": {
"title": "Create segment",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create an empty draft sequence. Nothing sends until it has steps, a From address and is activated. Returns the sequence. Errors: invalid_name, invalid_trigger (use manual, tag:<tag>, list:<id> or event:<name>). Next: set_sequence_steps, then activate_sequence. install_starter_sequence is faster for common flows.
| Parameter | Type | Description |
|---|---|---|
| from | ["string","null"] | The From address, such as "Acme <hello@acme.com>", on a verified domain. Needed before activating a sequence that sends email. |
| name * | string | Sequence name, 1 to 120 characters, such as "Welcome". |
| trigger * | string | What enrols a contact: "manual", "tag:<tag>", "list:<list id>" or "event:<event name>". |
| goal_event | ["string","null"] | Contacts who track this event leave the sequence, such as "upgraded". |
{
"name": "create_sequence",
"title": "Create sequence",
"description": "Create an empty draft sequence. Nothing sends until it has steps, a From address and is activated. Returns the sequence. Errors: invalid_name, invalid_trigger (use manual, tag:<tag>, list:<id> or event:<name>). Next: set_sequence_steps, then activate_sequence. install_starter_sequence is faster for common flows.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"trigger"
],
"properties": {
"from": {
"type": [
"string",
"null"
],
"default": null,
"description": "The From address, such as \"Acme <hello@acme.com>\", on a verified domain. Needed before activating a sequence that sends email."
},
"name": {
"type": "string",
"description": "Sequence name, 1 to 120 characters, such as \"Welcome\"."
},
"trigger": {
"type": "string",
"description": "What enrols a contact: \"manual\", \"tag:<tag>\", \"list:<list id>\" or \"event:<event name>\"."
},
"goal_event": {
"type": [
"string",
"null"
],
"default": null,
"description": "Contacts who track this event leave the sequence, such as \"upgraded\"."
}
}
},
"annotations": {
"title": "Create sequence",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a sync rule: when event_name happens and all conditions match, apply the action to the contact. Returns the rule. Errors: invalid_argument, invalid_event_name, list_not_found, field_not_found (create the contact field first), invalid_tag. Next: track_event to try it, then get_contact or list_contact_events to see the result.
| Parameter | Type | Description |
|---|---|---|
| name * | string | A name for the rule, such as "Tag pro customers". |
| action * | any | What to do: {"type": "add_tag", "tag": "customer"}, {"type": "remove_tag", "tag": "trial"}, {"type": "set_field", "key": "plan", "value": "pro"} or {"type": "add_to_list", "list_id": "lst_..."}. |
| conditions | any | All must match: [{"path": "plan", "op": "eq", "value": "pro"}]. Ops: eq, neq, gt, gte, lt, lte, contains, exists. |
| event_name * | string | The event that triggers it, custom or built-in (for example "plan_upgraded" or "tag.added"). |
{
"name": "create_sync_rule",
"title": "Create sync rule",
"description": "Create a sync rule: when event_name happens and all conditions match, apply the action to the contact. Returns the rule. Errors: invalid_argument, invalid_event_name, list_not_found, field_not_found (create the contact field first), invalid_tag. Next: track_event to try it, then get_contact or list_contact_events to see the result.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"event_name",
"action"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the rule, such as \"Tag pro customers\"."
},
"action": {
"description": "What to do: {\"type\": \"add_tag\", \"tag\": \"customer\"}, {\"type\": \"remove_tag\", \"tag\": \"trial\"},\n{\"type\": \"set_field\", \"key\": \"plan\", \"value\": \"pro\"} or {\"type\": \"add_to_list\", \"list_id\": \"lst_...\"}."
},
"conditions": {
"default": null,
"description": "All must match: [{\"path\": \"plan\", \"op\": \"eq\", \"value\": \"pro\"}]. Ops: eq, neq, gt, gte, lt, lte, contains, exists."
},
"event_name": {
"type": "string",
"description": "The event that triggers it, custom or built-in (for example \"plan_upgraded\" or \"tag.added\")."
}
}
},
"annotations": {
"title": "Create sync rule",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Create a transactional template from one of 18 starters (password-reset, magic-link, email-verification, verification-code, welcome, receipt, invoice, order-confirmation, shipping-notification, subscription-renewal, payment-failed, trial-ending, team-invite, login-alert, account-deleted, refund-issued, feedback-request, waitlist-confirmation) or a blank one, and publish it so it can be sent. Errors: template_slug_taken, unknown_starter, invalid_template_slug. Next: send_template.
| Parameter | Type | Description |
|---|---|---|
| name | ["string","null"] | Template name. Defaults to the starter name. |
| slug | ["string","null"] | URL-safe slug used in code. Defaults to the starter slug or the slugified name. |
| from_starter | ["string","null"] | A built-in starter slug such as "password-reset" or "welcome". |
{
"name": "create_template",
"title": "Create template",
"description": "Create a transactional template from one of 18 starters (password-reset, magic-link, email-verification, verification-code, welcome, receipt, invoice, order-confirmation, shipping-notification, subscription-renewal, payment-failed, trial-ending, team-invite, login-alert, account-deleted, refund-issued, feedback-request, waitlist-confirmation) or a blank one, and publish it so it can be sent. Errors: template_slug_taken, unknown_starter, invalid_template_slug. Next: send_template.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": [
"string",
"null"
],
"default": null,
"description": "Template name. Defaults to the starter name."
},
"slug": {
"type": [
"string",
"null"
],
"default": null,
"description": "URL-safe slug used in code. Defaults to the starter slug or the slugified name."
},
"from_starter": {
"type": [
"string",
"null"
],
"default": null,
"description": "A built-in starter slug such as \"password-reset\" or \"welcome\"."
}
}
},
"annotations": {
"title": "Create template",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Register a webhook: Runearc POSTs signed JSON events (Standard Webhooks) to the URL, retrying on failure. Returns {id, url, event_types, inbox_id, secret, created_at}; the secret is shown only once. Errors: invalid_webhook_url (https only, http allowed for localhost), invalid_event_type, not_found (inbox). Next: store the secret and verify each delivery's webhook-signature header with it. For a single expected email, wait_for_email is simpler than a webhook.
| Parameter | Type | Description |
|---|---|---|
| url * | string | Where to POST events: an https:// URL (http:// only for localhost). |
| inbox_id | ["string","null"] | Only deliver events for this inbox. Leave out for every inbox in the org. |
| event_types | array | Event types to deliver, such as ["message.received"]. Leave out for every event. Types: message.received, message.queued, message.delivered, message.deferred, message.bounced, message.complained, message.failed. |
{
"name": "create_webhook",
"title": "Create webhook",
"description": "Register a webhook: Runearc POSTs signed JSON events (Standard Webhooks) to the URL, retrying on failure. Returns {id, url, event_types, inbox_id, secret, created_at}; the secret is shown only once. Errors: invalid_webhook_url (https only, http allowed for localhost), invalid_event_type, not_found (inbox). Next: store the secret and verify each delivery's webhook-signature header with it. For a single expected email, wait_for_email is simpler than a webhook.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Where to POST events: an https:// URL (http:// only for localhost)."
},
"inbox_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only deliver events for this inbox. Leave out for every inbox in the org."
},
"event_types": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Event types to deliver, such as [\"message.received\"]. Leave out for every event.\nTypes: message.received, message.queued, message.delivered, message.deferred,\nmessage.bounced, message.complained, message.failed."
}
}
},
"annotations": {
"title": "Create webhook",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Delete an inbox and all of its messages. Mail to its address is rejected afterwards. This cannot be undone. Returns {deleted: true, id}. Errors: not_found, insufficient_scope. Next: create_inbox if you need a fresh address.
| Parameter | Type | Description |
|---|---|---|
| inbox_id * | string | Inbox id, such as "ibx_01j9...", from create_inbox or list_inboxes. |
{
"name": "delete_inbox",
"title": "Delete inbox",
"description": "Delete an inbox and all of its messages. Mail to its address is rejected afterwards. This cannot be undone. Returns {deleted: true, id}. Errors: not_found, insufficient_scope. Next: create_inbox if you need a fresh address.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id"
],
"properties": {
"inbox_id": {
"type": "string",
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes."
}
}
},
"annotations": {
"title": "Delete inbox",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Delete a landing page with its view counts and lead links (the contacts stay). Errors: not_found. Next: list_pages.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The page id (pg_...). |
{
"name": "delete_page",
"title": "Delete page",
"description": "Delete a landing page with its view counts and lead links (the contacts stay). Errors: not_found. Next: list_pages.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The page id (pg_...)."
}
}
},
"annotations": {
"title": "Delete page",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Permanently delete a saved segment (the saved filter only; the contacts in it are not touched). Built-in quick filters cannot be deleted. Returns {deleted: true}. Errors: not_found, builtin_segment_readonly. Next: list_segments.
| Parameter | Type | Description |
|---|---|---|
| segment_id * | string |
{
"name": "delete_segment",
"title": "Delete segment",
"description": "Permanently delete a saved segment (the saved filter only; the contacts in it are not touched). Built-in quick filters cannot be deleted. Returns {deleted: true}. Errors: not_found, builtin_segment_readonly. Next: list_segments.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"segment_id"
],
"properties": {
"segment_id": {
"type": "string"
}
}
},
"annotations": {
"title": "Delete segment",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Delete a sync rule so future events no longer trigger it. Changes it already made to contacts (tags, fields, lists) stay. Returns {deleted: id}. Errors: not_found (already deleted or wrong id; list_sync_rules shows the current ones). Next: list_sync_rules.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The id of the rule. |
{
"name": "delete_sync_rule",
"title": "Delete sync rule",
"description": "Delete a sync rule so future events no longer trigger it. Changes it already made to contacts (tags, fields, lists) stay. Returns {deleted: id}. Errors: not_found (already deleted or wrong id; list_sync_rules shows the current ones). Next: list_sync_rules.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The id of the rule."
}
}
},
"annotations": {
"title": "Delete sync rule",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Draft a 4 email welcome sequence (immediately, day 1, day 3, day 5) from an imported site. It is saved as a DRAFT: nothing is sent and nobody is enrolled. Returns {sequence_id, steps:[{position, delay_seconds, subject}], address_required}. Errors: import_not_found, welcome_draft_shape. Next: if address_required is true, set the business mailing address (PUT /v1/workspace/postal-address), then call turn_on_welcome_sequence with `sequence_id` once the user agrees.
| Parameter | Type | Description |
|---|---|---|
| style | ["string","null"] | "designed" (branded layout, default) or "plain" (looks like a personal email). |
| import_id * | string | The import id from import_site, such as "sim_01j9...". |
{
"name": "draft_welcome_sequence",
"title": "Draft welcome sequence",
"description": "Draft a 4 email welcome sequence (immediately, day 1, day 3, day 5) from an imported site. It is saved as a DRAFT: nothing is sent and nobody is enrolled. Returns {sequence_id, steps:[{position, delay_seconds, subject}], address_required}. Errors: import_not_found, welcome_draft_shape. Next: if address_required is true, set the business mailing address (PUT /v1/workspace/postal-address), then call turn_on_welcome_sequence with `sequence_id` once the user agrees.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"import_id"
],
"properties": {
"style": {
"type": [
"string",
"null"
],
"default": null,
"description": "\"designed\" (branded layout, default) or \"plain\" (looks like a personal email)."
},
"import_id": {
"type": "string",
"description": "The import id from import_site, such as \"sim_01j9...\"."
}
}
},
"annotations": {
"title": "Draft welcome sequence",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Enrol one contact in an active sequence now. Returns the enrolment {id, status, current_position, next_run_at}. Errors: sequence_not_active, contact_not_found, contact_not_mailable (unsubscribed or suppressed), already_enrolled, reenroll_not_allowed (pass force), invalid_enroll_target (give contact_id or email). Next: get_sequence to watch enrolment counts.
| Parameter | Type | Description |
|---|---|---|
| ["string","null"] | Contact email address. Give this or contact_id. | |
| force | boolean | Enrol again even if the contact already went through the sequence. Never overrides an active enrolment. |
| contact_id | ["string","null"] | Contact id, such as "ctc_01j9...". Give this or email. |
| sequence_id * | string | Sequence id. The sequence must be active. |
{
"name": "enroll_contact_in_sequence",
"title": "Enroll contact in sequence",
"description": "Enrol one contact in an active sequence now. Returns the enrolment {id, status, current_position, next_run_at}. Errors: sequence_not_active, contact_not_found, contact_not_mailable (unsubscribed or suppressed), already_enrolled, reenroll_not_allowed (pass force), invalid_enroll_target (give contact_id or email). Next: get_sequence to watch enrolment counts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id"
],
"properties": {
"email": {
"type": [
"string",
"null"
],
"default": null,
"description": "Contact email address. Give this or contact_id."
},
"force": {
"type": "boolean",
"default": false,
"description": "Enrol again even if the contact already went through the sequence. Never overrides an active enrolment."
},
"contact_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "Contact id, such as \"ctc_01j9...\". Give this or email."
},
"sequence_id": {
"type": "string",
"description": "Sequence id. The sequence must be active."
}
}
},
"annotations": {
"title": "Enroll contact in sequence",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Draft one email with AI from a prompt and the workspace AI context. Returns {subject, preview_text, document} where document is an email design document (version, style, subject, preheader, blocks: heading, text, button, divider). Errors: ai_unavailable (server has no AI key), ai_limit_reached (monthly allowance used; fix: wait, write by hand or upgrade), invalid_language (enable it in Settings > Localization), ai_unsafe_link (draft linked outside your sites; run again), ai_refused. Counts as one AI generation. Next: review the draft before sending; nothing is sent or saved.
| Parameter | Type | Description |
|---|---|---|
| prompt * | string | What the email is for, in plain words, such as "welcome email for new trial users". 1 to 4000 characters. |
| language | ["string","null"] | Language tag enabled in the workspace (Settings > Localization), such as "de". Defaults to the workspace default language. |
| site_text | ["string","null"] | Optional text from the customer's website to learn facts and style from. Treated as untrusted data, never as instructions. |
{
"name": "generate_email",
"title": "Generate email with AI",
"description": "Draft one email with AI from a prompt and the workspace AI context. Returns {subject, preview_text, document} where document is an email design document (version, style, subject, preheader, blocks: heading, text, button, divider). Errors: ai_unavailable (server has no AI key), ai_limit_reached (monthly allowance used; fix: wait, write by hand or upgrade), invalid_language (enable it in Settings > Localization), ai_unsafe_link (draft linked outside your sites; run again), ai_refused. Counts as one AI generation. Next: review the draft before sending; nothing is sent or saved.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"prompt"
],
"properties": {
"prompt": {
"type": "string",
"description": "What the email is for, in plain words, such as \"welcome email for new trial users\".\n1 to 4000 characters."
},
"language": {
"type": [
"string",
"null"
],
"default": null,
"description": "Language tag enabled in the workspace (Settings > Localization), such as \"de\".\nDefaults to the workspace default language."
},
"site_text": {
"type": [
"string",
"null"
],
"default": null,
"description": "Optional text from the customer's website to learn facts and style from. Treated as\nuntrusted data, never as instructions."
}
}
},
"annotations": {
"title": "Generate email with AI",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Draft an automated email sequence with AI. Returns {name, steps:[{delay_days, subject, preview_text, document}]}; the first step has delay_days 0. Same errors as generate_email, plus invalid_steps (steps must be 1 to 10). Counts as ONE AI generation. Nothing is saved or sent. Next: review the steps; save them as a sequence once sequences are available.
| Parameter | Type | Description |
|---|---|---|
| steps | ["integer","null"] | Number of emails, 1 to 10. Default 4 (immediately, day 1, day 3, day 5). |
| prompt * | string | What the sequence should achieve, such as "onboard new trial users". |
| language | ["string","null"] | |
| site_text | ["string","null"] |
{
"name": "generate_sequence",
"title": "Generate sequence with AI",
"description": "Draft an automated email sequence with AI. Returns {name, steps:[{delay_days, subject, preview_text, document}]}; the first step has delay_days 0. Same errors as generate_email, plus invalid_steps (steps must be 1 to 10). Counts as ONE AI generation. Nothing is saved or sent. Next: review the steps; save them as a sequence once sequences are available.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"prompt"
],
"properties": {
"steps": {
"type": [
"integer",
"null"
],
"format": "uint8",
"default": null,
"maximum": 255,
"minimum": 0,
"description": "Number of emails, 1 to 10. Default 4 (immediately, day 1, day 3, day 5)."
},
"prompt": {
"type": "string",
"description": "What the sequence should achieve, such as \"onboard new trial users\"."
},
"language": {
"type": [
"string",
"null"
],
"default": null
},
"site_text": {
"type": [
"string",
"null"
],
"default": null
}
}
},
"annotations": {
"title": "Generate sequence with AI",
"readOnlyHint": true,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Read the workspace AI context: product name and url, category, founder voice, tone, company context, extra instructions, and enabled languages. Returns {product_name, product_url, category, founder_name, founder_voice, tone, company_context, instructions, languages, default_language}. Next: generate_email or generate_sequence, which use this context automatically.
No parameters.
{
"name": "get_ai_context",
"title": "Get AI context",
"description": "Read the workspace AI context: product name and url, category, founder voice, tone, company context, extra instructions, and enabled languages. Returns {product_name, product_url, category, founder_name, founder_voice, tone, company_context, instructions, languages, default_language}. Next: generate_email or generate_sequence, which use this context automatically.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "Get AI context",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Email analytics for the workspace: sent, delivered, bounced, complained, opened, clicked, unsubscribed, conversions and revenue_cents as a zero filled time series (day buckets, hour buckets for ranges of two days or less), totals, rates (null when there is nothing to divide by) and a breakdown table. Counts are unique per recipient, bots ignored, counted when the event happened. Filter by range (7d, 30d, 90d, custom), type, source_id, step_id, provider and subscriber; group rows with by. `availability` says which sources exist: campaigns, sequences, conversions and segments are false until those features are set up, and their numbers are then zero. Errors: invalid_range, invalid_type, invalid_provider, invalid_subscriber, invalid_breakdown, segment_unavailable, insufficient_scope. Next: list_domains if sent is 0 and nothing has been sent yet.
| Parameter | Type | Description |
|---|---|---|
| by | ["string","null"] | How to group the table: "source" (default), "type" or "provider". |
| to | ["string","null"] | Last day for range=custom, YYYY-MM-DD (UTC, inclusive). At most 366 days in total. |
| from | ["string","null"] | First day for range=custom, YYYY-MM-DD (UTC, inclusive). |
| type | ["string","null"] | Send type: "transactional", "campaign" or "sequence". |
| range | ["string","null"] | Date range: "7d", "30d" (default), "90d" or "custom" (then from and to are required). |
| step_id | ["string","null"] | A sequence step or campaign email id, together with source_id. |
| provider | ["string","null"] |
Get the workspace email design: brand color, font, alignment, logo, header, footer and postal address. Returns {brand, design_md}; design_md is a markdown file you can edit and send back with set_email_design. Next: set_email_design, or render_email_preview to see how a document looks.
No parameters.
{
"name": "get_email_design",
"title": "Get email design",
"description": "Get the workspace email design: brand color, font, alignment, logo, header, footer and postal address. Returns {brand, design_md}; design_md is a markdown file you can edit and send back with set_email_design. Next: set_email_design, or render_email_preview to see how a document looks.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "Get email design",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Counted opens, unique opens, clicks, unique clickers and unsubscribes of one email, plus how many opens and clicks the bot filter flagged. Returns {opens, unique_opens, clicks, unique_clickers, unsubscribes, flagged_opens, flagged_clicks}. Errors: forbidden. Next: list the email's events with GET /v1/tracking/events?message_id=..., or change what is tracked with update_tracking_settings.
| Parameter | Type | Description |
|---|---|---|
| email_id * | string | Email id such as "eml_01j9...". |
{
"name": "get_email_tracking",
"title": "Get email tracking",
"description": "Counted opens, unique opens, clicks, unique clickers and unsubscribes of one email, plus how many opens and clicks the bot filter flagged. Returns {opens, unique_opens, clicks, unique_clickers, unsubscribes, flagged_opens, flagged_clicks}. Errors: forbidden. Next: list the email's events with GET /v1/tracking/events?message_id=..., or change what is tracked with update_tracking_settings.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email_id"
],
"properties": {
"email_id": {
"type": "string",
"description": "Email id such as \"eml_01j9...\"."
}
}
},
"annotations": {
"title": "Get email tracking",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Progress of a contact import. Returns {import: {status, total_rows, processed_rows, created_count, updated_count, skipped_count, error_count}, errors: [{row_number, email, code, message}]} (first 50 errors). Errors: not_found. Next: call again while status is queued or running; fix the rows in `errors` and import them again.
| Parameter | Type | Description |
|---|---|---|
| import_id * | string | Import id, such as "imp_01j9...", from import_contacts. |
{
"name": "get_import",
"title": "Get import status",
"description": "Progress of a contact import. Returns {import: {status, total_rows, processed_rows, created_count, updated_count, skipped_count, error_count}, errors: [{row_number, email, code, message}]} (first 50 errors). Errors: not_found. Next: call again while status is queued or running; fix the rows in `errors` and import them again.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"import_id"
],
"properties": {
"import_id": {
"type": "string",
"description": "Import id, such as \"imp_01j9...\", from import_contacts."
}
}
},
"annotations": {
"title": "Get import status",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get one inbox by id. Returns {id, address, display_name, created_at}. Errors: not_found. Next: list_messages or wait_for_email.
| Parameter | Type | Description |
|---|---|---|
| inbox_id * | string | Inbox id, such as "ibx_01j9...", from create_inbox or list_inboxes. |
{
"name": "get_inbox",
"title": "Get inbox",
"description": "Get one inbox by id. Returns {id, address, display_name, created_at}. Errors: not_found. Next: list_messages or wait_for_email.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id"
],
"properties": {
"inbox_id": {
"type": "string",
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes."
}
}
},
"annotations": {
"title": "Get inbox",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get one message with its text body and the one time codes and links found in it. Returns {id, inbox_id, thread_id, direction, status, from, to, cc, subject, text, codes, links, attachments, spam, created_at}; html only when include_html is true. Errors: not_found. Next: use codes[0] or a link from links to finish a sign up, or call reply to answer.
| Parameter | Type | Description |
|---|---|---|
| message_id * | string | Message id, such as "msg_01j9...". |
| include_html | boolean | Also return the HTML body. Off by default because the text body, codes and links are usually all an agent needs. |
{
"name": "get_message",
"title": "Get message",
"description": "Get one message with its text body and the one time codes and links found in it. Returns {id, inbox_id, thread_id, direction, status, from, to, cc, subject, text, codes, links, attachments, spam, created_at}; html only when include_html is true. Errors: not_found. Next: use codes[0] or a link from links to finish a sign up, or call reply to answer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"message_id"
],
"properties": {
"message_id": {
"type": "string",
"description": "Message id, such as \"msg_01j9...\"."
},
"include_html": {
"type": "boolean",
"default": false,
"description": "Also return the HTML body. Off by default because the text body, codes and links are\nusually all an agent needs."
}
}
},
"annotations": {
"title": "Get message",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read one landing page: draft blocks, status, form and public url. Errors: not_found. Next: update_page to edit it, or publish_page.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The page id (pg_...). |
{
"name": "get_page",
"title": "Get page",
"description": "Read one landing page: draft blocks, status, form and public url. Errors: not_found. Next: update_page to edit it, or publish_page.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The page id (pg_...)."
}
}
},
"annotations": {
"title": "Get page",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get one sequence with its trigger, goal, From address, ordered steps and enrolment counts. Returns the sequence. Errors: sequence_not_found. Next: set_sequence_steps to edit, activate_sequence to start it.
| Parameter | Type | Description |
|---|---|---|
| sequence_id * | string | Sequence id, such as "seq_01j9...", from list_sequences or create_sequence. |
{
"name": "get_sequence",
"title": "Get sequence",
"description": "Get one sequence with its trigger, goal, From address, ordered steps and enrolment counts. Returns the sequence. Errors: sequence_not_found. Next: set_sequence_steps to edit, activate_sequence to start it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence."
}
}
},
"annotations": {
"title": "Get sequence",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get a conversation with all of its messages, oldest first, each with text, codes and links. Returns {id, inbox_id, subject, message_count, last_message_at, messages: [...]}. Errors: not_found. Next: reply with the id of the last message to continue the conversation.
| Parameter | Type | Description |
|---|---|---|
| thread_id * | string | Thread id, such as "thr_01j9...", from list_threads or a message's thread_id. |
{
"name": "get_thread",
"title": "Get thread",
"description": "Get a conversation with all of its messages, oldest first, each with text, codes and links. Returns {id, inbox_id, subject, message_count, last_message_at, messages: [...]}. Errors: not_found. Next: reply with the id of the last message to continue the conversation.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"thread_id"
],
"properties": {
"thread_id": {
"type": "string",
"description": "Thread id, such as \"thr_01j9...\", from list_threads or a message's thread_id."
}
}
},
"annotations": {
"title": "Get thread",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Show the workspace's tracking settings: opens, clicks, unsubscribe, strict bot filter and the per-address frequency cap. Returns {track_opens, track_clicks, unsubscribe_enabled, strict_bot_filter, frequency_cap_count, frequency_cap_hours}. Next: update_tracking_settings to change them.
No parameters.
{
"name": "get_tracking_settings",
"title": "Get tracking settings",
"description": "Show the workspace's tracking settings: opens, clicks, unsubscribe, strict bot filter and the per-address frequency cap. Returns {track_opens, track_clicks, unsubscribe_enabled, strict_bot_filter, frequency_cap_count, frequency_cap_hours}. Next: update_tracking_settings to change them.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "Get tracking settings",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read-only results of one goal over the last `days` (default 30, 1 to 365): conversions, unique contacts, how many were credited to an email, revenue_cents and the top emails. Errors: not_found. Next: list_goals, or create_goal for another outcome.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The goal id (gol_...). |
| days | ["integer","null"] | Look back this many days (1 to 365, default 30). |
{
"name": "goal_stats",
"title": "Get goal stats",
"description": "Read-only results of one goal over the last `days` (default 30, 1 to 365): conversions, unique contacts, how many were credited to an email, revenue_cents and the top emails. Errors: not_found. Next: list_goals, or create_goal for another outcome.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The goal id (gol_...)."
},
"days": {
"type": [
"integer",
"null"
],
"format": "int64",
"default": null,
"description": "Look back this many days (1 to 365, default 30)."
}
}
},
"annotations": {
"title": "Get goal stats",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Import contacts from CSV text and start the import. Detects the email, first name and last name columns from the header. Returns {import, mapping_used}; the import runs in the background. Errors: empty_csv, invalid_csv, csv_too_large, too_many_rows, unknown_column, not_found (list). Next: get_import with import.id until import.status is done; rows that failed or were skipped are in `errors`.
| Parameter | Type | Description |
|---|---|---|
| csv * | string | The whole CSV file as text. First row is the header. Up to 25 MB. |
| tags | array | Tags to add to every imported contact. |
| filename | ["string","null"] | File name for the record, such as "customers.csv". |
| list_ids | array | List ids (lst_...) every imported contact is added to. |
| email_column | ["string","null"] | Header of the email column. Leave out to detect it ("email", "e-mail", ...). |
| update_existing | boolean | Merge into contacts that already exist instead of skipping them. Default false. |
{
"name": "import_contacts",
"title": "Import contacts from CSV",
"description": "Import contacts from CSV text and start the import. Detects the email, first name and last name columns from the header. Returns {import, mapping_used}; the import runs in the background. Errors: empty_csv, invalid_csv, csv_too_large, too_many_rows, unknown_column, not_found (list). Next: get_import with import.id until import.status is done; rows that failed or were skipped are in `errors`.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"csv"
],
"properties": {
"csv": {
"type": "string",
"description": "The whole CSV file as text. First row is the header. Up to 25 MB."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Tags to add to every imported contact."
},
"filename": {
"type": [
"string",
"null"
],
"default": null,
"description": "File name for the record, such as \"customers.csv\"."
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "List ids (lst_...) every imported contact is added to."
},
"email_column": {
"type": [
"string",
"null"
],
"default": null,
"description": "Header of the email column. Leave out to detect it (\"email\", \"e-mail\", ...)."
},
"update_existing": {
"type": "boolean",
"default": false,
"description": "Merge into contacts that already exist instead of skipping them. Default false."
}
}
},
"annotations": {
"title": "Import contacts from CSV",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Read a website and save its name, logo, brand colour and description as the workspace's brand and company context. Fetches only public web pages (private and internal addresses are refused). Returns {id, name, description, logo_url, color}. Errors: site_blocked, invalid_site_url, site_unreachable, site_not_html, too_many_redirects, site_import_rate_limited. Next: call draft_welcome_sequence with `id`.
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public address of the website, such as "acme.com" or "https://acme.com". |
{
"name": "import_site",
"title": "Import brand from website",
"description": "Read a website and save its name, logo, brand colour and description as the workspace's brand and company context. Fetches only public web pages (private and internal addresses are refused). Returns {id, name, description, logo_url, color}. Errors: site_blocked, invalid_site_url, site_unreachable, site_not_html, too_many_redirects, site_import_rate_limited. Next: call draft_welcome_sequence with `id`.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public address of the website, such as \"acme.com\" or \"https://acme.com\"."
}
}
},
"annotations": {
"title": "Import brand from website",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Create a draft sequence from a ready made one: welcome, onboarding, trial-ending, win-back, churn-save or review-request, with real email copy. Returns the sequence. Errors: starter_not_found. Next: update the From address and button links, then activate_sequence.
| Parameter | Type | Description |
|---|---|---|
| key * | string | One of "welcome", "onboarding", "trial-ending", "win-back", "churn-save", "review-request". |
{
"name": "install_starter_sequence",
"title": "Install starter sequence",
"description": "Create a draft sequence from a ready made one: welcome, onboarding, trial-ending, win-back, churn-save or review-request, with real email copy. Returns the sequence. Errors: starter_not_found. Next: update the From address and button links, then activate_sequence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"description": "One of \"welcome\", \"onboarding\", \"trial-ending\", \"win-back\", \"churn-save\", \"review-request\"."
}
}
},
"annotations": {
"title": "Install starter sequence",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}List connected billing providers (Stripe, Paddle, Lemon Squeezy, Polar, ...). Returns {integrations: [...]} with each webhook_path (prefix with the API origin) and last_event_at. Next: connect_billing_integration to add one.
No parameters.
{
"name": "list_billing_integrations",
"title": "List billing integrations",
"description": "List connected billing providers (Stripe, Paddle, Lemon Squeezy, Polar, ...). Returns {integrations: [...]} with each webhook_path (prefix with the API origin) and last_event_at. Next: connect_billing_integration to add one.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List billing integrations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the 8 starting designs for a campaign (slug, name, subject, document). Next: create_campaign with design set to a slug.
No parameters.
{
"name": "list_campaign_designs",
"title": "List campaign designs",
"description": "List the 8 starting designs for a campaign (slug, name, subject, document). Next: create_campaign with design set to a slug.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List campaign designs",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List broadcast campaigns, newest first, optionally only one status (draft, scheduled, sending, paused, sent, canceled). Each has counters: recipients_total, sent_count, suppressed_count, deferred_count, unsubscribed_count, failed_count. Next: create_campaign, or send_campaign for a draft.
| Parameter | Type | Description |
|---|---|---|
| status | ["string","null"] | Only this status: draft, scheduled, sending, paused, sent or canceled. |
{
"name": "list_campaigns",
"title": "List campaigns",
"description": "List broadcast campaigns, newest first, optionally only one status (draft, scheduled, sending, paused, sent, canceled). Each has counters: recipients_total, sent_count, suppressed_count, deferred_count, unsubscribed_count, failed_count. Next: create_campaign, or send_campaign for a draft.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only this status: draft, scheduled, sending, paused, sent or canceled."
}
}
},
"annotations": {
"title": "List campaigns",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List a contact's events, newest first. Returns {data: [...], next_cursor}. Errors: not_found (contact). Next: track_event to add one, or pass next_cursor back as cursor for the next page.
| Parameter | Type | Description |
|---|---|---|
| name | ["string","null"] | Only events with this name. |
| limit | ["integer","null"] | How many events (1 to 100, default 20). |
| cursor | ["string","null"] | The next_cursor of the previous page. |
| contact_id * | string | The contact id (ctc_...). |
{
"name": "list_contact_events",
"title": "List contact events",
"description": "List a contact's events, newest first. Returns {data: [...], next_cursor}. Errors: not_found (contact). Next: track_event to add one, or pass next_cursor back as cursor for the next page.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"name": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only events with this name."
},
"limit": {
"type": [
"integer",
"null"
],
"format": "int64",
"default": null,
"description": "How many events (1 to 100, default 20)."
},
"cursor": {
"type": [
"string",
"null"
],
"default": null,
"description": "The next_cursor of the previous page."
},
"contact_id": {
"type": "string",
"description": "The contact id (ctc_...)."
}
}
},
"annotations": {
"title": "List contact events",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Find contacts, newest first. Filter by q, status, tag or list_id. Returns {contacts: [...], next_cursor}. Pass next_cursor back as cursor for the next page. Next: update_contact, tag_contacts or unsubscribe_contact on a result.
| Parameter | Type | Description |
|---|---|---|
| q | ["string","null"] | Substring of email, first or last name. |
| tag | ["string","null"] | |
| limit | ["integer","null"] | 1 to 200, default 50. |
| cursor | ["string","null"] | next_cursor from the previous page. |
| status | ["string","null"] | active, unsubscribed, bounced or complained. |
| list_id | ["string","null"] |
{
"name": "list_contacts",
"title": "List contacts",
"description": "Find contacts, newest first. Filter by q, status, tag or list_id. Returns {contacts: [...], next_cursor}. Pass next_cursor back as cursor for the next page. Next: update_contact, tag_contacts or unsubscribe_contact on a result.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": [
"string",
"null"
],
"description": "Substring of email, first or last name."
},
"tag": {
"type": [
"string",
"null"
]
},
"limit": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "1 to 200, default 50."
},
"cursor": {
"type": [
"string",
"null"
],
"description": "next_cursor from the previous page."
},
"status": {
"type": [
"string",
"null"
],
"description": "active, unsubscribed, bounced or complained."
},
"list_id": {
"type": [
"string",
"null"
]
}
}
},
"annotations": {
"title": "List contacts",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the org's custom domains with their status and DNS records. Returns {domains: [...]}. Next: verify_domain for any that are not verified, or add_domain.
No parameters.
{
"name": "list_domains",
"title": "List domains",
"description": "List the org's custom domains with their status and DNS records. Returns {domains: [...]}. Next: verify_domain for any that are not verified, or add_domain.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List domains",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the custom event names this workspace has documented (name, description, property hints), so you use the same names in track_event and create_sync_rule. Read-only; events can be tracked without a definition. Returns {events: [...]}. Next: create_event_definition to document another, or create_sync_rule to act on one.
No parameters.
{
"name": "list_event_definitions",
"title": "List event definitions",
"description": "List the custom event names this workspace has documented (name, description, property hints), so you use the same names in track_event and create_sync_rule. Read-only; events can be tracked without a definition. Returns {events: [...]}. Next: create_event_definition to document another, or create_sync_rule to act on one.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List event definitions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Recent submissions of a form, newest first: {submissions:[{email,status,origin,page_url,created_at}]}. Status is accepted, pending_confirmation, confirmed, suppressed or spam. Errors: not_found (form). Next: list_contacts to see the people who joined, or create_popup to collect more signups.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","null"] | Max rows, default 50. |
| form_id * | string | The form id (frm_...). |
{
"name": "list_form_submissions",
"title": "List form submissions",
"description": "Recent submissions of a form, newest first: {submissions:[{email,status,origin,page_url,created_at}]}. Status is accepted, pending_confirmation, confirmed, suppressed or spam. Errors: not_found (form). Next: list_contacts to see the people who joined, or create_popup to collect more signups.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"form_id"
],
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"format": "int64",
"default": null,
"description": "Max rows, default 50."
},
"form_id": {
"type": "string",
"description": "The form id (frm_...)."
}
}
},
"annotations": {
"title": "List form submissions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the workspace's signup forms. Returns {forms:[{id,name,status,config,...}]}. Errors: insufficient_scope (needs a full access key). Next: list_form_submissions for who signed up, or create_form for a new one.
No parameters.
{
"name": "list_forms",
"title": "List signup forms",
"description": "List the workspace's signup forms. Returns {forms:[{id,name,status,config,...}]}. Errors: insufficient_scope (needs a full access key). Next: list_form_submissions for who signed up, or create_form for a new one.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List signup forms",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List conversion goals (an event plus conditions that counts as a win). Returns {goals: [...]}. Next: goal_stats for results, or create_goal.
No parameters.
{
"name": "list_goals",
"title": "List goals",
"description": "List conversion goals (an event plus conditions that counts as a win). Returns {goals: [...]}. Next: goal_stats for results, or create_goal.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List goals",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the inboxes this API key can use. Returns {inboxes: [{id, address, display_name, created_at}]}. Next: list_messages or wait_for_email with an inbox id, or create_inbox if there is none.
No parameters.
{
"name": "list_inboxes",
"title": "List inboxes",
"description": "List the inboxes this API key can use. Returns {inboxes: [{id, address, display_name, created_at}]}. Next: list_messages or wait_for_email with an inbox id, or create_inbox if there is none.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List inboxes",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List every contact list in the workspace (static lists, not segments) with member counts. Read-only. Returns {lists: [{id, name, description, member_count}]}. Next: add_to_list, or list_contacts with list_id to see members.
No parameters.
{
"name": "list_lists",
"title": "List contact lists",
"description": "List every contact list in the workspace (static lists, not segments) with member counts. Read-only. Returns {lists: [{id, name, description, member_count}]}. Next: add_to_list, or list_contacts with list_id to see members.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List contact lists",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List messages in an inbox, newest first, received and sent. Returns {messages: [{id, thread_id, direction, from, to, subject, preview, attachments, created_at}], next_cursor}. Pass next_cursor back as cursor for older messages. Errors: not_found (inbox). Next: get_message for the full text, codes and links; reply to answer one. To wait for a message that has not arrived yet, use wait_for_email instead of polling this.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","null"] | How many messages to return, newest first. 1 to 100, default 20. |
| cursor | ["string","null"] | The next_cursor from the previous page, to get older messages. |
| inbox_id * | string | Inbox id, such as "ibx_01j9...". |
{
"name": "list_messages",
"title": "List messages",
"description": "List messages in an inbox, newest first, received and sent. Returns {messages: [{id, thread_id, direction, from, to, subject, preview, attachments, created_at}], next_cursor}. Pass next_cursor back as cursor for older messages. Errors: not_found (inbox). Next: get_message for the full text, codes and links; reply to answer one. To wait for a message that has not arrived yet, use wait_for_email instead of polling this.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id"
],
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"format": "int64",
"default": null,
"description": "How many messages to return, newest first. 1 to 100, default 20."
},
"cursor": {
"type": [
"string",
"null"
],
"default": null,
"description": "The next_cursor from the previous page, to get older messages."
},
"inbox_id": {
"type": "string",
"description": "Inbox id, such as \"ibx_01j9...\"."
}
}
},
"annotations": {
"title": "List messages",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List the workspace's landing pages with status, views, leads and conversion per view. Returns {pages: [...]}. Errors: insufficient_scope (needs a full access key). Next: create_page, or publish_page for a draft.
No parameters.
{
"name": "list_pages",
"title": "List pages",
"description": "List the workspace's landing pages with status, views, leads and conversion per view. Returns {pages: [...]}. Errors: insufficient_scope (needs a full access key). Next: create_page, or publish_page for a draft.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List pages",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List segments: six built-in quick filters (builtin_*) then saved ones, each with a filter and a cached last_count. Next: preview_segment for a live count, create_segment to save your own.
No parameters.
{
"name": "list_segments",
"title": "List segments",
"description": "List segments: six built-in quick filters (builtin_*) then saved ones, each with a filter and a cached last_count. Next: preview_segment for a live count, create_segment to save your own.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List segments",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List sequences (lifecycle automations), newest first. Returns {sequences: [{id, name, status, trigger, steps, enrolled, active, completed, ...}]}. Next: get_sequence for one, install_starter_sequence for a ready made one, or create_sequence.
| Parameter | Type | Description |
|---|---|---|
| status | ["string","null"] | Only sequences with this status: "draft", "active" or "paused". Leave out for all. |
{
"name": "list_sequences",
"title": "List sequences",
"description": "List sequences (lifecycle automations), newest first. Returns {sequences: [{id, name, status, trigger, steps, enrolled, active, completed, ...}]}. Next: get_sequence for one, install_starter_sequence for a ready made one, or create_sequence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only sequences with this status: \"draft\", \"active\" or \"paused\". Leave out for all."
}
}
},
"annotations": {
"title": "List sequences",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List addresses that will not be emailed: hard bounces, complaints, manual blocks and unsubscribed contacts. Returns {suppressions: [{address, reason, created_at}], next_cursor, counts}. Errors: invalid_reason, invalid_cursor. Next: pass next_cursor as cursor for more.
| Parameter | Type | Description |
|---|---|---|
| q | ["string","null"] | Only addresses starting with this text. |
| cursor | ["string","null"] | next_cursor of the previous page. |
| reason | ["string","null"] | "hard_bounce", "complaint", "manual" or "unsubscribed". |
{
"name": "list_suppressions",
"title": "List suppressions",
"description": "List addresses that will not be emailed: hard bounces, complaints, manual blocks and unsubscribed contacts. Returns {suppressions: [{address, reason, created_at}], next_cursor, counts}. Errors: invalid_reason, invalid_cursor. Next: pass next_cursor as cursor for more.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only addresses starting with this text."
},
"cursor": {
"type": [
"string",
"null"
],
"default": null,
"description": "next_cursor of the previous page."
},
"reason": {
"type": [
"string",
"null"
],
"default": null,
"description": "\"hard_bounce\", \"complaint\", \"manual\" or \"unsubscribed\"."
}
}
},
"annotations": {
"title": "List suppressions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List sync rules: when an event matches, tag the contact, set a field or add it to a list. Returns {rules: [...]}. Next: create_sync_rule or delete_sync_rule.
No parameters.
{
"name": "list_sync_rules",
"title": "List sync rules",
"description": "List sync rules: when an event matches, tag the contact, set a field or add it to a list. Returns {rules: [...]}. Next: create_sync_rule or delete_sync_rule.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List sync rules",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List this workspace's transactional templates. Returns {data:[{id, slug, name, published_version_id}]}. Next: send_template, or create_template to add one.
No parameters.
{
"name": "list_templates",
"title": "List templates",
"description": "List this workspace's transactional templates. Returns {data:[{id, slug, name, published_version_id}]}. Next: send_template, or create_template to add one.",
"inputSchema": {
"type": "object",
"properties": {}
},
"annotations": {
"title": "List templates",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List conversations (threads) in an inbox, most recently active first, up to 100. Returns {threads: [{id, inbox_id, subject, message_count, last_message_at}]}. Errors: not_found (inbox). Next: get_thread to read a conversation.
| Parameter | Type | Description |
|---|---|---|
| inbox_id * | string | Inbox id, such as "ibx_01j9...", from create_inbox or list_inboxes. |
{
"name": "list_threads",
"title": "List threads",
"description": "List conversations (threads) in an inbox, most recently active first, up to 100. Returns {threads: [{id, inbox_id, subject, message_count, last_message_at}]}. Errors: not_found (inbox). Next: get_thread to read a conversation.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id"
],
"properties": {
"inbox_id": {
"type": "string",
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes."
}
}
},
"annotations": {
"title": "List threads",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Pause a sending campaign; pending recipients stay queued. Errors: campaign_not_pausable. Next: resume_campaign or cancel_campaign.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
{
"name": "pause_campaign",
"title": "Pause campaign",
"description": "Pause a sending campaign; pending recipients stay queued. Errors: campaign_not_pausable. Next: resume_campaign or cancel_campaign.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
}
}
},
"annotations": {
"title": "Pause campaign",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Pause an active sequence: no new contacts enter and no step runs; enrolments keep their place and catch up on resume. Returns the sequence with status "paused". Errors: sequence_not_found. Next: set_sequence_steps to edit it, then activate_sequence.
| Parameter | Type | Description |
|---|---|---|
| sequence_id * | string | Sequence id, such as "seq_01j9...", from list_sequences or create_sequence. |
{
"name": "pause_sequence",
"title": "Pause sequence",
"description": "Pause an active sequence: no new contacts enter and no step runs; enrolments keep their place and catch up on resume. Returns the sequence with status \"paused\". Errors: sequence_not_found. Next: set_sequence_steps to edit it, then activate_sequence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence."
}
}
},
"annotations": {
"title": "Pause sequence",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read-only performance of one popup made with create_popup: impressions, dismissals, conversions and conversion_rate (conversions / impressions, 0 when there are no impressions). Returns {impressions, dismissals, conversions, conversion_rate}. Errors: not_found (popup; use the id create_popup returned). Next: change the trigger or paths if the rate is low, or list_form_submissions to see who converted.
| Parameter | Type | Description |
|---|---|---|
| popup_id * | string | The popup id (pop_...). |
{
"name": "popup_stats",
"title": "Get popup stats",
"description": "Read-only performance of one popup made with create_popup: impressions, dismissals, conversions and conversion_rate (conversions / impressions, 0 when there are no impressions). Returns {impressions, dismissals, conversions, conversion_rate}. Errors: not_found (popup; use the id create_popup returned). Next: change the trigger or paths if the rate is low, or list_form_submissions to see who converted.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"popup_id"
],
"properties": {
"popup_id": {
"type": "string",
"description": "The popup id (pop_...)."
}
}
},
"annotations": {
"title": "Get popup stats",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Live count and a sample of contacts for a segment id or a draft filter, without saving. Returns {count, sample:[{id,email,first_name,last_name,status}]}. Engagement and event conditions match nobody until tracking data exists. Next: create_segment to save it.
| Parameter | Type | Description |
|---|---|---|
| limit | ["integer","null"] | Sample size, 1 to 100. Default 10. |
| filter | any | A draft filter, same shape as create_segment. |
| segment_id | ["string","null"] | A saved or built-in segment id (seg_..., builtin_engaged). Give this or `filter`. |
{
"name": "preview_segment",
"title": "Preview segment",
"description": "Live count and a sample of contacts for a segment id or a draft filter, without saving. Returns {count, sample:[{id,email,first_name,last_name,status}]}. Engagement and event conditions match nobody until tracking data exists. Next: create_segment to save it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": [
"integer",
"null"
],
"format": "int64",
"default": null,
"description": "Sample size, 1 to 100. Default 10."
},
"filter": {
"default": null,
"description": "A draft filter, same shape as create_segment."
},
"segment_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "A saved or built-in segment id (seg_..., builtin_engaged). Give this or `filter`."
}
}
},
"annotations": {
"title": "Preview segment",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Publish a landing page: freezes the draft as the live snapshot at /p/<workspace>/<slug>. Errors: page_needs_form (a signup block needs a form_id). Next: share the returned url, or list_pages to watch views and leads.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The page id (pg_...). |
{
"name": "publish_page",
"title": "Publish page",
"description": "Publish a landing page: freezes the draft as the live snapshot at /p/<workspace>/<slug>. Errors: page_needs_form (a signup block needs a form_id). Next: share the returned url, or list_pages to watch views and leads.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The page id (pg_...)."
}
}
},
"annotations": {
"title": "Publish page",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Disconnect a billing provider; its webhook URL stops working. Returns {deleted}. Errors: not_found. Next: list_billing_integrations to confirm.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The connection id (bil_...). |
{
"name": "remove_billing_integration",
"title": "Remove billing integration",
"description": "Disconnect a billing provider; its webhook URL stops working. Returns {deleted}. Errors: not_found. Next: list_billing_integrations to confirm.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The connection id (bil_...)."
}
}
},
"annotations": {
"title": "Remove billing integration",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Render an email document with the workspace brand, without sending. Returns {subject, html, text}. Errors: invalid_document, unknown_variable (add a fallback like {{FIRST_NAME|Friend}} or pass vars), missing_address, invalid_variable. Next: send it, or fix the document and render again.
| Parameter | Type | Description |
|---|---|---|
| vars | ["object","null"] | Values for {{NAME}} variables, such as {"FIRST_NAME":"Ana"}. |
| document * | any | The email document: {version:1, style:"designed"|"plain", subject, preheader?, blocks:[{type:"heading",text,level}|{type:"text",text}|{type:"button",label,url}| {type:"image",src,alt,href?}|{type:"divider"}|{type:"footer",unsubscribe}| {type:"rows",rows:[[label,value],...]}|{type:"code",code}]}. |
{
"name": "render_email_preview",
"title": "Render email preview",
"description": "Render an email document with the workspace brand, without sending. Returns {subject, html, text}. Errors: invalid_document, unknown_variable (add a fallback like {{FIRST_NAME|Friend}} or pass vars), missing_address, invalid_variable. Next: send it, or fix the document and render again.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"document"
],
"properties": {
"vars": {
"type": [
"object",
"null"
],
"default": null,
"description": "Values for {{NAME}} variables, such as {\"FIRST_NAME\":\"Ana\"}.",
"additionalProperties": {
"type": "string"
}
},
"document": {
"description": "The email document: {version:1, style:\"designed\"|\"plain\", subject, preheader?,\nblocks:[{type:\"heading\",text,level}|{type:\"text\",text}|{type:\"button\",label,url}|\n{type:\"image\",src,alt,href?}|{type:\"divider\"}|{type:\"footer\",unsubscribe}|\n{type:\"rows\",rows:[[label,value],...]}|{type:\"code\",code}]}."
}
}
},
"annotations": {
"title": "Render email preview",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Reply to a message in the same thread (sets In-Reply-To, References and a "Re:" subject). Replying to a message you sent follows up with its recipients. Returns {id, thread_id, status, from, to, cc, subject, created_at}. Errors: not_found (message), missing_body, no_reply_address, recipient_suppressed, daily_send_limit_reached, sending_paused, transport_unavailable. Next: wait_for_email on the inbox for their answer.
| Parameter | Type | Description |
|---|---|---|
| html | ["string","null"] | HTML body. Give text, html or both. |
| text | ["string","null"] | Plain text body. Give text, html or both. |
| reply_all | boolean | Also copy everyone else who was on the original message. Default false. |
| message_id * | string | Id of the message to reply to, such as "msg_01j9...". |
{
"name": "reply",
"title": "Reply to message",
"description": "Reply to a message in the same thread (sets In-Reply-To, References and a \"Re:\" subject). Replying to a message you sent follows up with its recipients. Returns {id, thread_id, status, from, to, cc, subject, created_at}. Errors: not_found (message), missing_body, no_reply_address, recipient_suppressed, daily_send_limit_reached, sending_paused, transport_unavailable. Next: wait_for_email on the inbox for their answer.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"message_id"
],
"properties": {
"html": {
"type": [
"string",
"null"
],
"default": null,
"description": "HTML body. Give text, html or both."
},
"text": {
"type": [
"string",
"null"
],
"default": null,
"description": "Plain text body. Give text, html or both."
},
"reply_all": {
"type": "boolean",
"default": false,
"description": "Also copy everyone else who was on the original message. Default false."
},
"message_id": {
"type": "string",
"description": "Id of the message to reply to, such as \"msg_01j9...\"."
}
}
},
"annotations": {
"title": "Reply to message",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Resume a paused campaign; sending continues with the pending recipients. Errors: campaign_not_resumable. Next: list_campaigns to watch the counters.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
{
"name": "resume_campaign",
"title": "Resume campaign",
"description": "Resume a paused campaign; sending continues with the pending recipients. Errors: campaign_not_resumable. Next: list_campaigns to watch the counters.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
}
}
},
"annotations": {
"title": "Resume campaign",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Send a draft campaign now, or schedule it with scheduled_at (RFC 3339, within 30 days). Runearc sends one personalised email per active contact, skipping unsubscribed and suppressed ones and spacing out contacts over the frequency cap. Errors: campaign_incomplete, campaign_not_sendable, invalid_schedule. Next: list_campaigns to watch the counters, pause_campaign or cancel_campaign to stop.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
| scheduled_at | ["string","null"] | RFC 3339 time to send at; leave out to send now. |
{
"name": "send_campaign",
"title": "Send campaign",
"description": "Send a draft campaign now, or schedule it with scheduled_at (RFC 3339, within 30 days). Runearc sends one personalised email per active contact, skipping unsubscribed and suppressed ones and spacing out contacts over the frequency cap. Errors: campaign_incomplete, campaign_not_sendable, invalid_schedule. Next: list_campaigns to watch the counters, pause_campaign or cancel_campaign to stop.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
},
"scheduled_at": {
"type": [
"string",
"null"
],
"default": null,
"description": "RFC 3339 time to send at; leave out to send now."
}
}
},
"annotations": {
"title": "Send campaign",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Send a campaign test to 1 to 5 addresses (subject prefixed [Test], no tracking, no recipient rows). Errors: campaign_incomplete (read the fix), invalid_test_recipients, campaign_canceled. Next: send_campaign.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
| to * | array | 1 to 5 addresses. |
{
"name": "send_campaign_test",
"title": "Send campaign test",
"description": "Send a campaign test to 1 to 5 addresses (subject prefixed [Test], no tracking, no recipient rows). Errors: campaign_incomplete (read the fix), invalid_test_recipients, campaign_canceled. Next: send_campaign.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"to"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
},
"to": {
"type": "array",
"items": {
"type": "string"
},
"description": "1 to 5 addresses."
}
}
},
"annotations": {
"title": "Send campaign test",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Send a new email from an inbox. Starts a new thread. Returns {id, thread_id, status, from, to, cc, subject, created_at}; status is "queued" until delivery. Errors: missing_body (give text or html), missing_recipients, invalid_address, invalid_subject, too_many_recipients, recipient_suppressed (address bounced or complained before), daily_send_limit_reached, monthly_send_limit_reached, sending_paused, transport_unavailable (sending not enabled on this server), not_found (inbox). Next: wait_for_email on the same inbox to catch the answer, or create_webhook for message.delivered events.
| Parameter | Type | Description |
|---|---|---|
| cc | array | Copied recipient addresses. |
| to * | array | Recipient addresses. |
| html | ["string","null"] | HTML body. Give text, html or both. |
| text | ["string","null"] | Plain text body. Give text, html or both. |
| subject * | string | |
| inbox_id * | string | Inbox id to send from, such as "ibx_01j9...". The From address is the inbox address. |
{
"name": "send_email",
"title": "Send email",
"description": "Send a new email from an inbox. Starts a new thread. Returns {id, thread_id, status, from, to, cc, subject, created_at}; status is \"queued\" until delivery. Errors: missing_body (give text or html), missing_recipients, invalid_address, invalid_subject, too_many_recipients, recipient_suppressed (address bounced or complained before), daily_send_limit_reached, monthly_send_limit_reached, sending_paused, transport_unavailable (sending not enabled on this server), not_found (inbox). Next: wait_for_email on the same inbox to catch the answer, or create_webhook for message.delivered events.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id",
"to",
"subject"
],
"properties": {
"cc": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Copied recipient addresses."
},
"to": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recipient addresses."
},
"html": {
"type": [
"string",
"null"
],
"default": null,
"description": "HTML body. Give text, html or both."
},
"text": {
"type": [
"string",
"null"
],
"default": null,
"description": "Plain text body. Give text, html or both."
},
"subject": {
"type": "string"
},
"inbox_id": {
"type": "string",
"description": "Inbox id to send from, such as \"ibx_01j9...\". The From address is the inbox address."
}
}
},
"annotations": {
"title": "Send email",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Send an email from a published transactional template. Returns {id}. Errors: template_not_found, template_not_published, missing_variable (names the variable), invalid_variable, template_conflict, recipient_suppressed, daily_send_limit_reached, sending_paused. Next: wait_for_email or create_webhook for delivery events.
| Parameter | Type | Description |
|---|---|---|
| to * | array | |
| from * | string | Sender on a verified domain, such as "Acme <noreply@acme.com>". |
| subject | ["string","null"] | Overrides the template subject. |
| template * | string | Template slug or tpl_ id. Must have a published version. |
| variables | any | Values for the template variables, for example {"RESET_URL": "https://..."}. |
{
"name": "send_template",
"title": "Send template email",
"description": "Send an email from a published transactional template. Returns {id}. Errors: template_not_found, template_not_published, missing_variable (names the variable), invalid_variable, template_conflict, recipient_suppressed, daily_send_limit_reached, sending_paused. Next: wait_for_email or create_webhook for delivery events.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"template",
"from",
"to"
],
"properties": {
"to": {
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "string",
"description": "Sender on a verified domain, such as \"Acme <noreply@acme.com>\"."
},
"subject": {
"type": [
"string",
"null"
],
"default": null,
"description": "Overrides the template subject."
},
"template": {
"type": "string",
"description": "Template slug or tpl_ id. Must have a published version."
},
"variables": {
"default": null,
"description": "Values for the template variables, for example {\"RESET_URL\": \"https://...\"}."
}
}
},
"annotations": {
"title": "Send template email",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Replace the workspace email design from a design.md file. Returns {brand}. Errors: invalid_design_md, invalid_brand (each has a fix), forbidden (needs a full scope key). Marketing email needs the ## Address section (CAN-SPAM). Next: render_email_preview.
| Parameter | Type | Description |
|---|---|---|
| design_md * | string | The whole design.md file: front matter (color, font, align, logo) then optional ## Header, ## Footer and ## Address sections. Get the current one with get_email_design and edit it. |
{
"name": "set_email_design",
"title": "Set email design",
"description": "Replace the workspace email design from a design.md file. Returns {brand}. Errors: invalid_design_md, invalid_brand (each has a fix), forbidden (needs a full scope key). Marketing email needs the ## Address section (CAN-SPAM). Next: render_email_preview.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"design_md"
],
"properties": {
"design_md": {
"type": "string",
"description": "The whole design.md file: front matter (color, font, align, logo) then\noptional ## Header, ## Footer and ## Address sections. Get the current\none with get_email_design and edit it."
}
}
},
"annotations": {
"title": "Set email design",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Replace all steps of a draft or paused sequence. Returns the sequence. Errors: sequence_active (pause it first), invalid_steps (the steps JSON does not parse), sequence_empty, too_many_steps, invalid_delay, invalid_email_step, invalid_branch (branches jump forward only). Next: activate_sequence.
| Parameter | Type | Description |
|---|---|---|
| steps * | array | The ordered steps. Each is {"kind":"email","subject":"..","preview":"..","doc":{"version":1,"style":"designed","subject":"..","blocks":[{"type":"text","text":"Hi {{FIRST_NAME|there}}"}]}}, {"kind":"delay","days":1} (or "minutes"/"hours"), {"kind":"condition","check":{"kind":"has_tag","tag":"vip"},"o… |
| sequence_id * | string | Sequence id. The sequence must be a draft or paused. |
{
"name": "set_sequence_steps",
"title": "Set sequence steps",
"description": "Replace all steps of a draft or paused sequence. Returns the sequence. Errors: sequence_active (pause it first), invalid_steps (the steps JSON does not parse), sequence_empty, too_many_steps, invalid_delay, invalid_email_step, invalid_branch (branches jump forward only). Next: activate_sequence.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id",
"steps"
],
"properties": {
"steps": {
"type": "array",
"items": true,
"description": "The ordered steps. Each is {\"kind\":\"email\",\"subject\":\"..\",\"preview\":\"..\",\"doc\":{\"version\":1,\"style\":\"designed\",\"subject\":\"..\",\"blocks\":[{\"type\":\"text\",\"text\":\"Hi {{FIRST_NAME|there}}\"}]}}, {\"kind\":\"delay\",\"days\":1} (or \"minutes\"/\"hours\"), {\"kind\":\"condition\",\"check\":{\"kind\":\"has_tag\",\"tag\":\"vip\"},\"on_true\":3,\"on_false\":null} (branches jump forward to a step index) or {\"kind\":\"exit\"}."
},
"sequence_id": {
"type": "string",
"description": "Sequence id. The sequence must be a draft or paused."
}
}
},
"annotations": {
"title": "Set sequence steps",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Attach a tag to contacts (the tag is created if missing). Returns {tagged: n} for newly tagged contacts. Errors: not_found (contact), invalid_tag. Next: list_contacts with tag to see them.
| Parameter | Type | Description |
|---|---|---|
| tag * | string | Tag name; created when missing. |
| emails * | array | Emails or ids (ctc_...) of existing contacts. |
{
"name": "tag_contacts",
"title": "Tag contacts",
"description": "Attach a tag to contacts (the tag is created if missing). Returns {tagged: n} for newly tagged contacts. Errors: not_found (contact), invalid_tag. Next: list_contacts with tag to see them.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"emails",
"tag"
],
"properties": {
"tag": {
"type": "string",
"description": "Tag name; created when missing."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Emails or ids (ctc_...) of existing contacts."
}
}
},
"annotations": {
"title": "Tag contacts",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Record that a contact did something, such as plan_upgraded. Runearc then applies sync rules (tags, fields, lists) and goals. Returns the event with duplicate=true when the idempotency_key was seen before. Errors: contact_not_found (create the contact first), reserved_event_name, invalid_event_name, invalid_properties, properties_too_large, idempotency_key_reused. Next: list_contact_events to confirm it, or create_sync_rule to react to it.
| Parameter | Type | Description |
|---|---|---|
| name * | string | The event name: lowercase letters, digits and _ . : - starting with a letter, such as "plan_upgraded". Built-in names (email.opened, tag.added, ...) are reserved. |
| email * | string | Email of an existing contact the event is about. |
| properties | any | Event properties as a JSON object, up to 16 KB, such as {"plan": "pro", "amount": 49}. |
| idempotency_key | ["string","null"] | Repeating the same key returns the first event instead of recording a second one. |
{
"name": "track_event",
"title": "Track contact event",
"description": "Record that a contact did something, such as plan_upgraded. Runearc then applies sync rules (tags, fields, lists) and goals. Returns the event with duplicate=true when the idempotency_key was seen before. Errors: contact_not_found (create the contact first), reserved_event_name, invalid_event_name, invalid_properties, properties_too_large, idempotency_key_reused. Next: list_contact_events to confirm it, or create_sync_rule to react to it.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The event name: lowercase letters, digits and _ . : - starting with a letter, such as\n\"plan_upgraded\". Built-in names (email.opened, tag.added, ...) are reserved."
},
"email": {
"type": "string",
"description": "Email of an existing contact the event is about."
},
"properties": {
"default": null,
"description": "Event properties as a JSON object, up to 16 KB, such as {\"plan\": \"pro\", \"amount\": 49}."
},
"idempotency_key": {
"type": [
"string",
"null"
],
"default": null,
"description": "Repeating the same key returns the first event instead of recording a second one."
}
}
},
"annotations": {
"title": "Track contact event",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Turn on the welcome sequence: from now on contacts matching its audience are enrolled and emailed. Ask the user first, this is the step that sends mail. Returns {sequence_id, active: true}. Errors: postal_address_required (CAN-SPAM, add the address first), welcome_not_found. Next: add contacts, or watch the sequence's analytics.
| Parameter | Type | Description |
|---|---|---|
| sequence_id * | string | The welcome sequence id from draft_welcome_sequence, such as "seq_01j9...". |
{
"name": "turn_on_welcome_sequence",
"title": "Turn on welcome sequence",
"description": "Turn on the welcome sequence: from now on contacts matching its audience are enrolled and emailed. Ask the user first, this is the step that sends mail. Returns {sequence_id, active: true}. Errors: postal_address_required (CAN-SPAM, add the address first), welcome_not_found. Next: add contacts, or watch the sequence's analytics.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sequence_id"
],
"properties": {
"sequence_id": {
"type": "string",
"description": "The welcome sequence id from draft_welcome_sequence, such as \"seq_01j9...\"."
}
}
},
"annotations": {
"title": "Turn on welcome sequence",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Take a landing page offline; the address answers not found. Counts and leads are kept. Errors: not_found. Next: publish_page to bring it back.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The page id (pg_...). |
{
"name": "unpublish_page",
"title": "Unpublish page",
"description": "Take a landing page offline; the address answers not found. Counts and leads are kept. Errors: not_found. Next: publish_page to bring it back.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The page id (pg_...)."
}
}
},
"annotations": {
"title": "Unpublish page",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Unsubscribe a contact so broadcasts skip them. Returns the contact with status unsubscribed. Errors: not_found. Next: list_contacts with status unsubscribed to review.
| Parameter | Type | Description |
|---|---|---|
| email * | string | The contact's email or id (ctc_...). |
{
"name": "unsubscribe_contact",
"title": "Unsubscribe contact",
"description": "Unsubscribe a contact so broadcasts skip them. Returns the contact with status unsubscribed. Errors: not_found. Next: list_contacts with status unsubscribed to review.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The contact's email or id (ctc_...)."
}
}
},
"annotations": {
"title": "Unsubscribe contact",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Unsubscribe addresses from marketing mail. Unknown addresses become unsubscribed contacts, so a later import cannot resubscribe them. Transactional mail still sends. Returns the operation {id, status, total}. Errors: too_many_targets, empty_selection. Next: list_suppressions with reason "unsubscribed".
| Parameter | Type | Description |
|---|---|---|
| emails * | array | Addresses to unsubscribe from marketing mail (max 10000). Unknown addresses are remembered. |
{
"name": "unsubscribe_contacts",
"title": "Unsubscribe contacts",
"description": "Unsubscribe addresses from marketing mail. Unknown addresses become unsubscribed contacts, so a later import cannot resubscribe them. Transactional mail still sends. Returns the operation {id, status, total}. Errors: too_many_targets, empty_selection. Next: list_suppressions with reason \"unsubscribed\".",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Addresses to unsubscribe from marketing mail (max 10000). Unknown addresses are remembered."
}
}
},
"annotations": {
"title": "Unsubscribe contacts",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Edit a draft campaign: name, subject, preheader, from_address (a verified sender), reply_to, document (email design JSON) and audience ({kind:list,id} | {kind:segment,id} | {kind:tag,name}). Only drafts can be edited. Errors: campaign_not_editable, invalid_address, invalid_document, invalid_field, not_found. Next: send_campaign_test, then send_campaign.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The campaign id (cmp_...). |
| name | ["string","null"] | |
| subject | ["string","null"] | Subject line; variables like {{FIRST_NAME|there}} are allowed. |
| audience | any | {kind:"list",id} | {kind:"segment",id} | {kind:"tag",name}. |
| document | any | Email design document: {version:1, style, subject, blocks:[...]}. |
| reply_to | ["string","null"] | |
| preheader | ["string","null"] | |
| from_address | ["string","null"] | Sender address on a verified domain, such as news@example.com. |
Change a contact's names, source or revenue. Pass an empty string to clear a name. Returns the contact. Errors: not_found, invalid_revenue. Next: list_contacts to confirm.
| Parameter | Type | Description |
|---|---|---|
| email * | string | The contact's email or id (ctc_...). |
| source | ["string","null"] | |
| last_name | ["string","null"] | |
| first_name | ["string","null"] | Empty string clears. |
| revenue_cents | ["integer","null"] |
{
"name": "update_contact",
"title": "Update contact",
"description": "Change a contact's names, source or revenue. Pass an empty string to clear a name. Returns the contact. Errors: not_found, invalid_revenue. Next: list_contacts to confirm.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The contact's email or id (ctc_...)."
},
"source": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"first_name": {
"type": [
"string",
"null"
],
"description": "Empty string clears."
},
"revenue_cents": {
"type": [
"integer",
"null"
],
"format": "int64"
}
}
},
"annotations": {
"title": "Update contact",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Change a landing page draft: name, slug, SEO title, description, signup form_id (null clears it) or the whole blocks array. A published page keeps serving its snapshot until publish_page. Errors: invalid_page_link, too_many_blocks, too_many_signup_blocks, page_slug_taken, invalid_page_form. Next: publish_page.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The page id (pg_...). |
| name | ["string","null"] | |
| slug | ["string","null"] | |
| title | ["string","null"] | SEO title. |
| blocks | ["array","null"] | The whole ordered blocks array. Types: hero, features, signup, cta, footer. |
| form_id | ["string","null"] | The signup form (frm_...). |
| clear_form | boolean | Set true to remove the signup form from the page. |
| description | ["string","null"] | SEO description. |
{
"name": "update_page",
"title": "Update page",
"description": "Change a landing page draft: name, slug, SEO title, description, signup form_id (null clears it) or the whole blocks array. A published page keeps serving its snapshot until publish_page. Errors: invalid_page_link, too_many_blocks, too_many_signup_blocks, page_slug_taken, invalid_page_form. Next: publish_page.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The page id (pg_...)."
},
"name": {
"type": [
"string",
"null"
],
"default": null
},
"slug": {
"type": [
"string",
"null"
],
"default": null
},
"title": {
"type": [
"string",
"null"
],
"default": null,
"description": "SEO title."
},
"blocks": {
"type": [
"array",
"null"
],
"items": true,
"default": null,
"description": "The whole ordered blocks array. Types: hero, features, signup, cta, footer."
},
"form_id": {
"type": [
"string",
"null"
],
"default": null,
"description": "The signup form (frm_...)."
},
"clear_form": {
"type": "boolean",
"default": false,
"description": "Set true to remove the signup form from the page."
},
"description": {
"type": [
"string",
"null"
],
"default": null,
"description": "SEO description."
}
}
},
"annotations": {
"title": "Update page",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Change tracking settings; only the fields you pass change. Marketing mail is mail tagged category=marketing: only it gets unsubscribe links and the frequency cap. Errors: invalid_frequency_cap (1 to 1000 emails per 1 to 8760 hours), forbidden. Returns the new settings. Next: get_tracking_settings to confirm, then send_email with the category=marketing tag.
| Parameter | Type | Description |
|---|---|---|
| track_opens | ["boolean","null"] | Track opens with a first-party pixel. |
| track_clicks | ["boolean","null"] | Rewrite links to signed redirects that count clicks. |
| strict_bot_filter | ["boolean","null"] | Flag opens and clicks from scanners, prefetchers and instant hits instead of counting them. |
| clear_frequency_cap | boolean | Set true to remove the cap. |
| frequency_cap_count | ["integer","null"] | Max marketing emails per address per window; use with frequency_cap_hours. |
| frequency_cap_hours | ["integer","null"] | Window of the cap in hours. |
| unsubscribe_enabled | ["boolean","null"] | Add List-Unsubscribe headers and a footer link to marketing mail. |
Check a domain's DNS records now and update its status. Returns the domain with status "verified", "pending" or "failing", and per record status ok, missing or wrong with a fix. DNS changes can take a few minutes to be visible. Errors: domain_not_found. Next: if not verified, apply each record's fix and call this again; once verified, create_inbox with domain set.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name, such as "acme.com", or its id, such as "dom_01j9...". |
{
"name": "verify_domain",
"title": "Verify domain DNS",
"description": "Check a domain's DNS records now and update its status. Returns the domain with status \"verified\", \"pending\" or \"failing\", and per record status ok, missing or wrong with a fix. DNS changes can take a few minutes to be visible. Errors: domain_not_found. Next: if not verified, apply each record's fix and call this again; once verified, create_inbox with domain set.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name, such as \"acme.com\", or its id, such as \"dom_01j9...\"."
}
}
},
"annotations": {
"title": "Verify domain DNS",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Wait until an email arrives in an inbox, then return it with the one time codes and links extracted, so a sign up is two calls: create_inbox, then this. Blocks up to timeout_seconds (default 60, max 120). Returns {message: {id, from, subject, text, codes, links, ...}, codes, links}: codes are 4 to 8 digit OTPs, most likely first; links are https URLs such as verification links. Only messages received after `after` (default: now) match, so pass the inbox's created_at if the email may already be there. With the catch-all inbox (any address @{code}.runearc.email), pass `to` with the address you signed up with. Errors: wait_timeout (nothing matched in time: safe to call again, or loosen from/subject_contains), invalid_timeout, not_found (inbox). Next: enter codes[0] or open the verification link.
| Parameter | Type | Description |
|---|---|---|
| to | ["string","null"] | Only match mail sent to this exact address (envelope recipient, To or Cc), such as "signup-42@k7m3qz.runearc.email". Lets several waits share the catch-all inbox. |
| from | ["string","null"] | Only match senders whose address contains this, case insensitive, such as "github.com". |
| after | ["string","null"] | Only match messages received after this RFC 3339 time, such as the inbox's created_at. Default: when this call starts. Set it when the email may already have arrived. |
| inbox_id * | string | Inbox id to watch, such as "ibx_01j9...". |
| timeout_seconds | ["integer","null"] | Seconds to wait, 1 to 120. Default 60. |
| subject_contains | ["string","null"] |
Runearc gives you real email inboxes. To sign up for a service: create_inbox, give its address to the service, then wait_for_email (returns OTP codes and links). To send: send_email from an inbox, reply to answer a message. Transactional templates: create_template, then send_template. To load contacts: import_contacts with CSV text, then get_import. To stop marketing mail to people: unsubscribe_contacts. Errors carry a code, a message and a fix: follow the fix.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "create_popup",
"title": "Create popup",
"description": "Create a popup that shows a form on a trigger (time, scroll or exit_intent), optionally only on some paths. Errors: invalid_popup_config, not_found (form), invalid_status. Next: set status live, then add the runearc-embed.js script with data-popup=\"ID\" to your site; popup_stats shows conversions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"form_id",
"heading"
],
"properties": {
"name": {
"type": "string",
"description": "A name for the popup, such as \"Blog exit offer\"."
},
"status": {
"type": [
"string",
"null"
],
"default": null,
"description": "draft or live. Default draft."
},
"form_id": {
"type": "string",
"description": "The form to show (frm_...)."
},
"heading": {
"type": "string",
"description": "The popup headline."
},
"trigger": {
"type": [
"string",
"null"
],
"default": null,
"description": "time, scroll or exit_intent. Default time."
},
"only_paths": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Only on URLs starting with these paths, such as [\"/blog\"]. Empty means every page."
},
"days_between": {
"type": [
"integer",
"null"
],
"format": "uint32",
"default": null,
"minimum": 0,
"description": "Days before showing again to the same visitor. Default 7."
},
"trigger_value": {
"type": [
"integer",
"null"
],
"format": "uint32",
"default": null,
"minimum": 0,
"description": "Seconds for time, percent for scroll. Default 5 and 50."
}
}
},
"annotations": {
"title": "Create popup",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}| Outbound provider: "ses", "kumo" or "unknown". |
| source_id | ["string","null"] | A campaign or sequence id, to look at one send. |
| subscriber | ["string","null"] | One subscriber's email address, or a segment id (seg_...). |
{
"name": "get_analytics",
"title": "Get email analytics",
"description": "Email analytics for the workspace: sent, delivered, bounced, complained, opened, clicked, unsubscribed, conversions and revenue_cents as a zero filled time series (day buckets, hour buckets for ranges of two days or less), totals, rates (null when there is nothing to divide by) and a breakdown table. Counts are unique per recipient, bots ignored, counted when the event happened. Filter by range (7d, 30d, 90d, custom), type, source_id, step_id, provider and subscriber; group rows with by. `availability` says which sources exist: campaigns, sequences, conversions and segments are false until those features are set up, and their numbers are then zero. Errors: invalid_range, invalid_type, invalid_provider, invalid_subscriber, invalid_breakdown, segment_unavailable, insufficient_scope. Next: list_domains if sent is 0 and nothing has been sent yet.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"by": {
"type": [
"string",
"null"
],
"description": "How to group the table: \"source\" (default), \"type\" or \"provider\"."
},
"to": {
"type": [
"string",
"null"
],
"description": "Last day for range=custom, YYYY-MM-DD (UTC, inclusive). At most 366 days in total."
},
"from": {
"type": [
"string",
"null"
],
"description": "First day for range=custom, YYYY-MM-DD (UTC, inclusive)."
},
"type": {
"type": [
"string",
"null"
],
"description": "Send type: \"transactional\", \"campaign\" or \"sequence\"."
},
"range": {
"type": [
"string",
"null"
],
"description": "Date range: \"7d\", \"30d\" (default), \"90d\" or \"custom\" (then from and to are required)."
},
"step_id": {
"type": [
"string",
"null"
],
"description": "A sequence step or campaign email id, together with source_id."
},
"provider": {
"type": [
"string",
"null"
],
"description": "Outbound provider: \"ses\", \"kumo\" or \"unknown\"."
},
"source_id": {
"type": [
"string",
"null"
],
"description": "A campaign or sequence id, to look at one send."
},
"subscriber": {
"type": [
"string",
"null"
],
"description": "One subscriber's email address, or a segment id (seg_...)."
}
}
},
"annotations": {
"title": "Get email analytics",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "update_campaign",
"title": "Update campaign",
"description": "Edit a draft campaign: name, subject, preheader, from_address (a verified sender), reply_to, document (email design JSON) and audience ({kind:list,id} | {kind:segment,id} | {kind:tag,name}). Only drafts can be edited. Errors: campaign_not_editable, invalid_address, invalid_document, invalid_field, not_found. Next: send_campaign_test, then send_campaign.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The campaign id (cmp_...)."
},
"name": {
"type": [
"string",
"null"
],
"default": null
},
"subject": {
"type": [
"string",
"null"
],
"default": null,
"description": "Subject line; variables like {{FIRST_NAME|there}} are allowed."
},
"audience": {
"default": null,
"description": "{kind:\"list\",id} | {kind:\"segment\",id} | {kind:\"tag\",name}."
},
"document": {
"default": null,
"description": "Email design document: {version:1, style, subject, blocks:[...]}."
},
"reply_to": {
"type": [
"string",
"null"
],
"default": null
},
"preheader": {
"type": [
"string",
"null"
],
"default": null
},
"from_address": {
"type": [
"string",
"null"
],
"default": null,
"description": "Sender address on a verified domain, such as news@example.com."
}
}
},
"annotations": {
"title": "Update campaign",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}{
"name": "update_tracking_settings",
"title": "Update tracking settings",
"description": "Change tracking settings; only the fields you pass change. Marketing mail is mail tagged category=marketing: only it gets unsubscribe links and the frequency cap. Errors: invalid_frequency_cap (1 to 1000 emails per 1 to 8760 hours), forbidden. Returns the new settings. Next: get_tracking_settings to confirm, then send_email with the category=marketing tag.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"track_opens": {
"type": [
"boolean",
"null"
],
"default": null,
"description": "Track opens with a first-party pixel."
},
"track_clicks": {
"type": [
"boolean",
"null"
],
"default": null,
"description": "Rewrite links to signed redirects that count clicks."
},
"strict_bot_filter": {
"type": [
"boolean",
"null"
],
"default": null,
"description": "Flag opens and clicks from scanners, prefetchers and instant hits instead of counting them."
},
"clear_frequency_cap": {
"type": "boolean",
"default": false,
"description": "Set true to remove the cap."
},
"frequency_cap_count": {
"type": [
"integer",
"null"
],
"format": "int32",
"default": null,
"description": "Max marketing emails per address per window; use with frequency_cap_hours."
},
"frequency_cap_hours": {
"type": [
"integer",
"null"
],
"format": "int32",
"default": null,
"description": "Window of the cap in hours."
},
"unsubscribe_enabled": {
"type": [
"boolean",
"null"
],
"default": null,
"description": "Add List-Unsubscribe headers and a footer link to marketing mail."
}
}
},
"annotations": {
"title": "Update tracking settings",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}| Only match subjects that contain this, case insensitive, such as "verify". |
{
"name": "wait_for_email",
"title": "Wait for email",
"description": "Wait until an email arrives in an inbox, then return it with the one time codes and links extracted, so a sign up is two calls: create_inbox, then this. Blocks up to timeout_seconds (default 60, max 120). Returns {message: {id, from, subject, text, codes, links, ...}, codes, links}: codes are 4 to 8 digit OTPs, most likely first; links are https URLs such as verification links. Only messages received after `after` (default: now) match, so pass the inbox's created_at if the email may already be there. With the catch-all inbox (any address @{code}.runearc.email), pass `to` with the address you signed up with. Errors: wait_timeout (nothing matched in time: safe to call again, or loosen from/subject_contains), invalid_timeout, not_found (inbox). Next: enter codes[0] or open the verification link.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"inbox_id"
],
"properties": {
"to": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only match mail sent to this exact address (envelope recipient, To or Cc), such as\n\"signup-42@k7m3qz.runearc.email\". Lets several waits share the catch-all inbox."
},
"from": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only match senders whose address contains this, case insensitive, such as \"github.com\"."
},
"after": {
"type": [
"string",
"null"
],
"format": "date-time",
"default": null,
"description": "Only match messages received after this RFC 3339 time, such as the inbox's created_at.\nDefault: when this call starts. Set it when the email may already have arrived."
},
"inbox_id": {
"type": "string",
"description": "Inbox id to watch, such as \"ibx_01j9...\"."
},
"timeout_seconds": {
"type": [
"integer",
"null"
],
"format": "uint64",
"default": null,
"minimum": 0,
"description": "Seconds to wait, 1 to 120. Default 60."
},
"subject_contains": {
"type": [
"string",
"null"
],
"default": null,
"description": "Only match subjects that contain this, case insensitive, such as \"verify\"."
}
}
},
"annotations": {
"title": "Wait for email",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}