Server definition
- Hash
- sha256:e9945c94f9a4be788113d7af47b553a85c9137ef8fd0fa5897ca54612f07ffc3
- What it is
- What a remote MCP server returned when asked what it offers: 90 tools
The blob, as servednamed by its sha256
{
"instructions": "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.",
"tools": [
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sequence_id": {
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence.",
"type": "string"
}
},
"required": [
"sequence_id"
],
"type": "object"
},
"name": "activate_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"description": "The contact's email address.",
"type": "string"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"list_ids": {
"default": [],
"description": "Ids (lst_...) of lists to join.",
"items": {
"type": "string"
},
"type": "array"
},
"revenue_cents": {
"description": "Lifetime revenue in cents.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"source": {
"description": "Where they came from, such as \"signup\" or \"import\".",
"type": [
"string",
"null"
]
},
"tags": {
"default": [],
"description": "Tags to attach; created when missing.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"email"
],
"type": "object"
},
"name": "add_contact",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"description": "Domain name to send and receive on, such as \"acme.com\" or \"mail.acme.com\".",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "add_domain",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"emails": {
"description": "Emails or ids (ctc_...) of existing contacts.",
"items": {
"type": "string"
},
"type": "array"
},
"list_id": {
"description": "List id (lst_...).",
"type": "string"
}
},
"required": [
"list_id",
"emails"
],
"type": "object"
},
"name": "add_to_list",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"action": {
"description": "\"tag\", \"add_to_list\", \"unsubscribe\" or \"delete\".",
"type": "string"
},
"all_matching": {
"default": null,
"description": "Act on every contact matching this filter {q, status, tag, list_id}; {} means all contacts."
},
"contact_ids": {
"default": null,
"description": "Contact ids (ctc_...). Give exactly one of contact_ids, emails or all_matching.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"emails": {
"default": null,
"description": "Email addresses of contacts.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"list_id": {
"default": null,
"description": "For \"add_to_list\": the list id (lst_...).",
"type": [
"string",
"null"
]
},
"tags": {
"default": [],
"description": "For \"tag\": the tags to add.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"action"
],
"type": "object"
},
"name": "bulk_contacts",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "cancel_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"provider": {
"description": "stripe, paddle, lemonsqueezy, polar, revenuecat, adapty or shopify.",
"type": "string"
},
"secret": {
"default": null,
"description": "The provider's webhook signing secret. Omit to have Runearc generate one.",
"type": [
"string",
"null"
]
}
},
"required": [
"provider"
],
"type": "object"
},
"name": "connect_billing_integration",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"copy_of": {
"default": null,
"description": "Optional campaign id (cmp_...) to copy.",
"type": [
"string",
"null"
]
},
"design": {
"default": null,
"description": "Optional design slug from list_campaign_designs.",
"type": [
"string",
"null"
]
},
"name": {
"description": "Campaign name, for example \"November product update\".",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"description": {
"default": null,
"description": "What the event means.",
"type": [
"string",
"null"
]
},
"name": {
"description": "The event name, such as \"plan_upgraded\".",
"type": "string"
},
"properties": {
"default": null,
"description": "Documentation of the properties: [{\"name\": \"plan\", \"type\": \"string\"}]. Not enforced."
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_event_definition",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"allowed_origins": {
"default": [],
"description": "Websites allowed to submit, such as [\"https://example.com\"]. Empty means any.",
"items": {
"type": "string"
},
"type": "array"
},
"double_opt_in": {
"default": false,
"description": "Send a confirmation email first (double opt-in).",
"type": "boolean"
},
"list_ids": {
"default": [],
"description": "Add new contacts to these lists (list ids).",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "A name for the form, such as \"Footer signup\".",
"type": "string"
},
"tags": {
"default": [],
"description": "Tag new contacts with these tags.",
"items": {
"type": "string"
},
"type": "array"
},
"template": {
"default": null,
"description": "Starting template: newsletter, waitlist or product-updates. Default newsletter.",
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_form",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"conditions": {
"default": null,
"description": "Optional property conditions, same shape as for sync rules."
},
"event_name": {
"description": "The event that counts as a conversion.",
"type": "string"
},
"name": {
"description": "A unique name, such as \"Upgraded to pro\".",
"type": "string"
},
"value_property": {
"default": null,
"description": "Property holding the revenue of the event, such as \"amount\".",
"type": [
"string",
"null"
]
},
"window_days": {
"default": null,
"description": "Attribution window in days, 1 to 90 (default 7): an email sent or clicked this long before gets the credit.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"name",
"event_name"
],
"type": "object"
},
"name": "create_goal",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"display_name": {
"default": null,
"description": "Name shown in the From header of mail sent from this inbox, such as \"Acme Bot\".",
"type": [
"string",
"null"
]
},
"domain": {
"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).",
"type": [
"string",
"null"
]
},
"name": {
"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\".",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "create_inbox",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_list",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"form_id": {
"default": null,
"description": "The signup form (frm_...) the signup block uses.",
"type": [
"string",
"null"
]
},
"name": {
"description": "A name for the page, such as \"Spring launch\".",
"type": "string"
},
"slug": {
"default": null,
"description": "URL slug (3 to 40 lowercase letters, digits, hyphens). Default: from the name.",
"type": [
"string",
"null"
]
},
"template": {
"default": null,
"description": "Starting template: blank, waitlist, product-launch or newsletter. Default blank.",
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_page",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days_between": {
"default": null,
"description": "Days before showing again to the same visitor. Default 7.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"form_id": {
"description": "The form to show (frm_...).",
"type": "string"
},
"heading": {
"description": "The popup headline.",
"type": "string"
},
"name": {
"description": "A name for the popup, such as \"Blog exit offer\".",
"type": "string"
},
"only_paths": {
"default": [],
"description": "Only on URLs starting with these paths, such as [\"/blog\"]. Empty means every page.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"default": null,
"description": "draft or live. Default draft.",
"type": [
"string",
"null"
]
},
"trigger": {
"default": null,
"description": "time, scroll or exit_intent. Default time.",
"type": [
"string",
"null"
]
},
"trigger_value": {
"default": null,
"description": "Seconds for time, percent for scroll. Default 5 and 50.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"name",
"form_id",
"heading"
],
"type": "object"
},
"name": "create_popup",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"description": {
"default": "",
"description": "What it is for.",
"type": "string"
},
"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}."
},
"name": {
"description": "Segment name, unique in the workspace.",
"type": "string"
}
},
"required": [
"name",
"filter"
],
"type": "object"
},
"name": "create_segment",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"from": {
"default": null,
"description": "The From address, such as \"Acme <[email protected]>\", on a verified domain. Needed before activating a sequence that sends email.",
"type": [
"string",
"null"
]
},
"goal_event": {
"default": null,
"description": "Contacts who track this event leave the sequence, such as \"upgraded\".",
"type": [
"string",
"null"
]
},
"name": {
"description": "Sequence name, 1 to 120 characters, such as \"Welcome\".",
"type": "string"
},
"trigger": {
"description": "What enrols a contact: \"manual\", \"tag:<tag>\", \"list:<list id>\" or \"event:<event name>\".",
"type": "string"
}
},
"required": [
"name",
"trigger"
],
"type": "object"
},
"name": "create_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"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": {
"description": "The event that triggers it, custom or built-in (for example \"plan_upgraded\" or \"tag.added\").",
"type": "string"
},
"name": {
"description": "A name for the rule, such as \"Tag pro customers\".",
"type": "string"
}
},
"required": [
"name",
"event_name",
"action"
],
"type": "object"
},
"name": "create_sync_rule",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"from_starter": {
"default": null,
"description": "A built-in starter slug such as \"password-reset\" or \"welcome\".",
"type": [
"string",
"null"
]
},
"name": {
"default": null,
"description": "Template name. Defaults to the starter name.",
"type": [
"string",
"null"
]
},
"slug": {
"default": null,
"description": "URL-safe slug used in code. Defaults to the starter slug or the slugified name.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "create_template",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"event_types": {
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"inbox_id": {
"default": null,
"description": "Only deliver events for this inbox. Leave out for every inbox in the org.",
"type": [
"string",
"null"
]
},
"url": {
"description": "Where to POST events: an https:// URL (http:// only for localhost).",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "create_webhook",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"inbox_id": {
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes.",
"type": "string"
}
},
"required": [
"inbox_id"
],
"type": "object"
},
"name": "delete_inbox",
"outputSchema": null
},
{
"description": "Delete a landing page with its view counts and lead links (the contacts stay). Errors: not_found. Next: list_pages.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The page id (pg_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_page",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"segment_id": {
"type": "string"
}
},
"required": [
"segment_id"
],
"type": "object"
},
"name": "delete_segment",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The id of the rule.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_sync_rule",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"import_id": {
"description": "The import id from import_site, such as \"sim_01j9...\".",
"type": "string"
},
"style": {
"default": null,
"description": "\"designed\" (branded layout, default) or \"plain\" (looks like a personal email).",
"type": [
"string",
"null"
]
}
},
"required": [
"import_id"
],
"type": "object"
},
"name": "draft_welcome_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"contact_id": {
"default": null,
"description": "Contact id, such as \"ctc_01j9...\". Give this or email.",
"type": [
"string",
"null"
]
},
"email": {
"default": null,
"description": "Contact email address. Give this or contact_id.",
"type": [
"string",
"null"
]
},
"force": {
"default": false,
"description": "Enrol again even if the contact already went through the sequence. Never overrides an active enrolment.",
"type": "boolean"
},
"sequence_id": {
"description": "Sequence id. The sequence must be active.",
"type": "string"
}
},
"required": [
"sequence_id"
],
"type": "object"
},
"name": "enroll_contact_in_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"language": {
"default": null,
"description": "Language tag enabled in the workspace (Settings > Localization), such as \"de\".\nDefaults to the workspace default language.",
"type": [
"string",
"null"
]
},
"prompt": {
"description": "What the email is for, in plain words, such as \"welcome email for new trial users\".\n1 to 4000 characters.",
"type": "string"
},
"site_text": {
"default": null,
"description": "Optional text from the customer's website to learn facts and style from. Treated as\nuntrusted data, never as instructions.",
"type": [
"string",
"null"
]
}
},
"required": [
"prompt"
],
"type": "object"
},
"name": "generate_email",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"language": {
"default": null,
"type": [
"string",
"null"
]
},
"prompt": {
"description": "What the sequence should achieve, such as \"onboard new trial users\".",
"type": "string"
},
"site_text": {
"default": null,
"type": [
"string",
"null"
]
},
"steps": {
"default": null,
"description": "Number of emails, 1 to 10. Default 4 (immediately, day 1, day 3, day 5).",
"format": "uint8",
"maximum": 255,
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"prompt"
],
"type": "object"
},
"name": "generate_sequence",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "get_ai_context",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"by": {
"description": "How to group the table: \"source\" (default), \"type\" or \"provider\".",
"type": [
"string",
"null"
]
},
"from": {
"description": "First day for range=custom, YYYY-MM-DD (UTC, inclusive).",
"type": [
"string",
"null"
]
},
"provider": {
"description": "Outbound provider: \"ses\", \"kumo\" or \"unknown\".",
"type": [
"string",
"null"
]
},
"range": {
"description": "Date range: \"7d\", \"30d\" (default), \"90d\" or \"custom\" (then from and to are required).",
"type": [
"string",
"null"
]
},
"source_id": {
"description": "A campaign or sequence id, to look at one send.",
"type": [
"string",
"null"
]
},
"step_id": {
"description": "A sequence step or campaign email id, together with source_id.",
"type": [
"string",
"null"
]
},
"subscriber": {
"description": "One subscriber's email address, or a segment id (seg_...).",
"type": [
"string",
"null"
]
},
"to": {
"description": "Last day for range=custom, YYYY-MM-DD (UTC, inclusive). At most 366 days in total.",
"type": [
"string",
"null"
]
},
"type": {
"description": "Send type: \"transactional\", \"campaign\" or \"sequence\".",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "get_analytics",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "get_email_design",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email_id": {
"description": "Email id such as \"eml_01j9...\".",
"type": "string"
}
},
"required": [
"email_id"
],
"type": "object"
},
"name": "get_email_tracking",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"import_id": {
"description": "Import id, such as \"imp_01j9...\", from import_contacts.",
"type": "string"
}
},
"required": [
"import_id"
],
"type": "object"
},
"name": "get_import",
"outputSchema": null
},
{
"description": "Get one inbox by id. Returns {id, address, display_name, created_at}. Errors: not_found. Next: list_messages or wait_for_email.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"inbox_id": {
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes.",
"type": "string"
}
},
"required": [
"inbox_id"
],
"type": "object"
},
"name": "get_inbox",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"include_html": {
"default": false,
"description": "Also return the HTML body. Off by default because the text body, codes and links are\nusually all an agent needs.",
"type": "boolean"
},
"message_id": {
"description": "Message id, such as \"msg_01j9...\".",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "get_message",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The page id (pg_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_page",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sequence_id": {
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence.",
"type": "string"
}
},
"required": [
"sequence_id"
],
"type": "object"
},
"name": "get_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"thread_id": {
"description": "Thread id, such as \"thr_01j9...\", from list_threads or a message's thread_id.",
"type": "string"
}
},
"required": [
"thread_id"
],
"type": "object"
},
"name": "get_thread",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "get_tracking_settings",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"days": {
"default": null,
"description": "Look back this many days (1 to 365, default 30).",
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"description": "The goal id (gol_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "goal_stats",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"csv": {
"description": "The whole CSV file as text. First row is the header. Up to 25 MB.",
"type": "string"
},
"email_column": {
"default": null,
"description": "Header of the email column. Leave out to detect it (\"email\", \"e-mail\", ...).",
"type": [
"string",
"null"
]
},
"filename": {
"default": null,
"description": "File name for the record, such as \"customers.csv\".",
"type": [
"string",
"null"
]
},
"list_ids": {
"default": [],
"description": "List ids (lst_...) every imported contact is added to.",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"default": [],
"description": "Tags to add to every imported contact.",
"items": {
"type": "string"
},
"type": "array"
},
"update_existing": {
"default": false,
"description": "Merge into contacts that already exist instead of skipping them. Default false.",
"type": "boolean"
}
},
"required": [
"csv"
],
"type": "object"
},
"name": "import_contacts",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"url": {
"description": "Public address of the website, such as \"acme.com\" or \"https://acme.com\".",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "import_site",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"key": {
"description": "One of \"welcome\", \"onboarding\", \"trial-ending\", \"win-back\", \"churn-save\", \"review-request\".",
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"name": "install_starter_sequence",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_billing_integrations",
"outputSchema": null
},
{
"description": "List the 8 starting designs for a campaign (slug, name, subject, document). Next: create_campaign with design set to a slug.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "list_campaign_designs",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"default": null,
"description": "Only this status: draft, scheduled, sending, paused, sent or canceled.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "list_campaigns",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"contact_id": {
"description": "The contact id (ctc_...).",
"type": "string"
},
"cursor": {
"default": null,
"description": "The next_cursor of the previous page.",
"type": [
"string",
"null"
]
},
"limit": {
"default": null,
"description": "How many events (1 to 100, default 20).",
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"default": null,
"description": "Only events with this name.",
"type": [
"string",
"null"
]
}
},
"required": [
"contact_id"
],
"type": "object"
},
"name": "list_contact_events",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cursor": {
"description": "next_cursor from the previous page.",
"type": [
"string",
"null"
]
},
"limit": {
"description": "1 to 200, default 50.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"list_id": {
"type": [
"string",
"null"
]
},
"q": {
"description": "Substring of email, first or last name.",
"type": [
"string",
"null"
]
},
"status": {
"description": "active, unsubscribed, bounced or complained.",
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "list_contacts",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_domains",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_event_definitions",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"form_id": {
"description": "The form id (frm_...).",
"type": "string"
},
"limit": {
"default": null,
"description": "Max rows, default 50.",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"form_id"
],
"type": "object"
},
"name": "list_form_submissions",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_forms",
"outputSchema": null
},
{
"description": "List conversion goals (an event plus conditions that counts as a win). Returns {goals: [...]}. Next: goal_stats for results, or create_goal.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "list_goals",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_inboxes",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_lists",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cursor": {
"default": null,
"description": "The next_cursor from the previous page, to get older messages.",
"type": [
"string",
"null"
]
},
"inbox_id": {
"description": "Inbox id, such as \"ibx_01j9...\".",
"type": "string"
},
"limit": {
"default": null,
"description": "How many messages to return, newest first. 1 to 100, default 20.",
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"inbox_id"
],
"type": "object"
},
"name": "list_messages",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_pages",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_segments",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"status": {
"default": null,
"description": "Only sequences with this status: \"draft\", \"active\" or \"paused\". Leave out for all.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "list_sequences",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cursor": {
"default": null,
"description": "next_cursor of the previous page.",
"type": [
"string",
"null"
]
},
"q": {
"default": null,
"description": "Only addresses starting with this text.",
"type": [
"string",
"null"
]
},
"reason": {
"default": null,
"description": "\"hard_bounce\", \"complaint\", \"manual\" or \"unsubscribed\".",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "list_suppressions",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_sync_rules",
"outputSchema": null
},
{
"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": {
"properties": {},
"type": "object"
},
"name": "list_templates",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"inbox_id": {
"description": "Inbox id, such as \"ibx_01j9...\", from create_inbox or list_inboxes.",
"type": "string"
}
},
"required": [
"inbox_id"
],
"type": "object"
},
"name": "list_threads",
"outputSchema": null
},
{
"description": "Pause a sending campaign; pending recipients stay queued. Errors: campaign_not_pausable. Next: resume_campaign or cancel_campaign.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "pause_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sequence_id": {
"description": "Sequence id, such as \"seq_01j9...\", from list_sequences or create_sequence.",
"type": "string"
}
},
"required": [
"sequence_id"
],
"type": "object"
},
"name": "pause_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"popup_id": {
"description": "The popup id (pop_...).",
"type": "string"
}
},
"required": [
"popup_id"
],
"type": "object"
},
"name": "popup_stats",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"filter": {
"default": null,
"description": "A draft filter, same shape as create_segment."
},
"limit": {
"default": null,
"description": "Sample size, 1 to 100. Default 10.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"segment_id": {
"default": null,
"description": "A saved or built-in segment id (seg_..., builtin_engaged). Give this or `filter`.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "preview_segment",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The page id (pg_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "publish_page",
"outputSchema": null
},
{
"description": "Disconnect a billing provider; its webhook URL stops working. Returns {deleted}. Errors: not_found. Next: list_billing_integrations to confirm.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The connection id (bil_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "remove_billing_integration",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"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}]}."
},
"vars": {
"additionalProperties": {
"type": "string"
},
"default": null,
"description": "Values for {{NAME}} variables, such as {\"FIRST_NAME\":\"Ana\"}.",
"type": [
"object",
"null"
]
}
},
"required": [
"document"
],
"type": "object"
},
"name": "render_email_preview",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"html": {
"default": null,
"description": "HTML body. Give text, html or both.",
"type": [
"string",
"null"
]
},
"message_id": {
"description": "Id of the message to reply to, such as \"msg_01j9...\".",
"type": "string"
},
"reply_all": {
"default": false,
"description": "Also copy everyone else who was on the original message. Default false.",
"type": "boolean"
},
"text": {
"default": null,
"description": "Plain text body. Give text, html or both.",
"type": [
"string",
"null"
]
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "reply",
"outputSchema": null
},
{
"description": "Resume a paused campaign; sending continues with the pending recipients. Errors: campaign_not_resumable. Next: list_campaigns to watch the counters.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "resume_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
},
"scheduled_at": {
"default": null,
"description": "RFC 3339 time to send at; leave out to send now.",
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
},
"name": "send_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
},
"to": {
"description": "1 to 5 addresses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"to"
],
"type": "object"
},
"name": "send_campaign_test",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"cc": {
"default": [],
"description": "Copied recipient addresses.",
"items": {
"type": "string"
},
"type": "array"
},
"html": {
"default": null,
"description": "HTML body. Give text, html or both.",
"type": [
"string",
"null"
]
},
"inbox_id": {
"description": "Inbox id to send from, such as \"ibx_01j9...\". The From address is the inbox address.",
"type": "string"
},
"subject": {
"type": "string"
},
"text": {
"default": null,
"description": "Plain text body. Give text, html or both.",
"type": [
"string",
"null"
]
},
"to": {
"description": "Recipient addresses.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"inbox_id",
"to",
"subject"
],
"type": "object"
},
"name": "send_email",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"from": {
"description": "Sender on a verified domain, such as \"Acme <[email protected]>\".",
"type": "string"
},
"subject": {
"default": null,
"description": "Overrides the template subject.",
"type": [
"string",
"null"
]
},
"template": {
"description": "Template slug or tpl_ id. Must have a published version.",
"type": "string"
},
"to": {
"items": {
"type": "string"
},
"type": "array"
},
"variables": {
"default": null,
"description": "Values for the template variables, for example {\"RESET_URL\": \"https://...\"}."
}
},
"required": [
"template",
"from",
"to"
],
"type": "object"
},
"name": "send_template",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"design_md": {
"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.",
"type": "string"
}
},
"required": [
"design_md"
],
"type": "object"
},
"name": "set_email_design",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sequence_id": {
"description": "Sequence id. The sequence must be a draft or paused.",
"type": "string"
},
"steps": {
"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\"}.",
"items": true,
"type": "array"
}
},
"required": [
"sequence_id",
"steps"
],
"type": "object"
},
"name": "set_sequence_steps",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"emails": {
"description": "Emails or ids (ctc_...) of existing contacts.",
"items": {
"type": "string"
},
"type": "array"
},
"tag": {
"description": "Tag name; created when missing.",
"type": "string"
}
},
"required": [
"emails",
"tag"
],
"type": "object"
},
"name": "tag_contacts",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"description": "Email of an existing contact the event is about.",
"type": "string"
},
"idempotency_key": {
"default": null,
"description": "Repeating the same key returns the first event instead of recording a second one.",
"type": [
"string",
"null"
]
},
"name": {
"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.",
"type": "string"
},
"properties": {
"default": null,
"description": "Event properties as a JSON object, up to 16 KB, such as {\"plan\": \"pro\", \"amount\": 49}."
}
},
"required": [
"email",
"name"
],
"type": "object"
},
"name": "track_event",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sequence_id": {
"description": "The welcome sequence id from draft_welcome_sequence, such as \"seq_01j9...\".",
"type": "string"
}
},
"required": [
"sequence_id"
],
"type": "object"
},
"name": "turn_on_welcome_sequence",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"description": "The page id (pg_...).",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "unpublish_page",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"description": "The contact's email or id (ctc_...).",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"name": "unsubscribe_contact",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"emails": {
"description": "Addresses to unsubscribe from marketing mail (max 10000). Unknown addresses are remembered.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"emails"
],
"type": "object"
},
"name": "unsubscribe_contacts",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"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:[...]}."
},
"from_address": {
"default": null,
"description": "Sender address on a verified domain, such as [email protected].",
"type": [
"string",
"null"
]
},
"id": {
"description": "The campaign id (cmp_...).",
"type": "string"
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"preheader": {
"default": null,
"type": [
"string",
"null"
]
},
"reply_to": {
"default": null,
"type": [
"string",
"null"
]
},
"subject": {
"default": null,
"description": "Subject line; variables like {{FIRST_NAME|there}} are allowed.",
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_campaign",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"description": "The contact's email or id (ctc_...).",
"type": "string"
},
"first_name": {
"description": "Empty string clears.",
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"revenue_cents": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
}
},
"required": [
"email"
],
"type": "object"
},
"name": "update_contact",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"blocks": {
"default": null,
"description": "The whole ordered blocks array. Types: hero, features, signup, cta, footer.",
"items": true,
"type": [
"array",
"null"
]
},
"clear_form": {
"default": false,
"description": "Set true to remove the signup form from the page.",
"type": "boolean"
},
"description": {
"default": null,
"description": "SEO description.",
"type": [
"string",
"null"
]
},
"form_id": {
"default": null,
"description": "The signup form (frm_...).",
"type": [
"string",
"null"
]
},
"id": {
"description": "The page id (pg_...).",
"type": "string"
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"slug": {
"default": null,
"type": [
"string",
"null"
]
},
"title": {
"default": null,
"description": "SEO title.",
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_page",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"clear_frequency_cap": {
"default": false,
"description": "Set true to remove the cap.",
"type": "boolean"
},
"frequency_cap_count": {
"default": null,
"description": "Max marketing emails per address per window; use with frequency_cap_hours.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"frequency_cap_hours": {
"default": null,
"description": "Window of the cap in hours.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"strict_bot_filter": {
"default": null,
"description": "Flag opens and clicks from scanners, prefetchers and instant hits instead of counting them.",
"type": [
"boolean",
"null"
]
},
"track_clicks": {
"default": null,
"description": "Rewrite links to signed redirects that count clicks.",
"type": [
"boolean",
"null"
]
},
"track_opens": {
"default": null,
"description": "Track opens with a first-party pixel.",
"type": [
"boolean",
"null"
]
},
"unsubscribe_enabled": {
"default": null,
"description": "Add List-Unsubscribe headers and a footer link to marketing mail.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
},
"name": "update_tracking_settings",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"domain": {
"description": "Domain name, such as \"acme.com\", or its id, such as \"dom_01j9...\".",
"type": "string"
}
},
"required": [
"domain"
],
"type": "object"
},
"name": "verify_domain",
"outputSchema": null
},
{
"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": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"after": {
"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.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"from": {
"default": null,
"description": "Only match senders whose address contains this, case insensitive, such as \"github.com\".",
"type": [
"string",
"null"
]
},
"inbox_id": {
"description": "Inbox id to watch, such as \"ibx_01j9...\".",
"type": "string"
},
"subject_contains": {
"default": null,
"description": "Only match subjects that contain this, case insensitive, such as \"verify\".",
"type": [
"string",
"null"
]
},
"timeout_seconds": {
"default": null,
"description": "Seconds to wait, 1 to 120. Default 60.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"to": {
"default": null,
"description": "Only match mail sent to this exact address (envelope recipient, To or Cc), such as\n\"[email protected]\". Lets several waits share the catch-all inbox.",
"type": [
"string",
"null"
]
}
},
"required": [
"inbox_id"
],
"type": "object"
},
"name": "wait_for_email",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:e9945c94f9a4be788113d7af47b553a85c9137ef8fd0fa5897ca54612f07ffc3 | sha256sum