mailblaze_add_subscriber

WRITE, MAY SEND A CONFIRMATION EMAIL: add one subscriber to a mailing list. Depending on the list's settings Mail Blaze may send the person a confirmation (double opt-in) email. Only add people who agreed to receive your email. An email that is already on the list answers with a conflict error.

destructive

Argument	Type	Description
email*	string
list_uid*	string
last_name	string	Sets the LNAME field.
first_name	string	Sets the FNAME field.
custom_fields	object	Custom field values keyed by the field's tag (see mailblaze_list_list_fields), e.g. {"PHONE": "+1 555 0100"}.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "pattern": "^[^\\s@<>\",;]+@[^\\s@<>\",;]+\\.[^\\s@<>\",;]+$",
      "maxLength": 254,
      "minLength": 3
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "last_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Sets the LNAME field."
    },
    "first_name": {
      "type": "string",
      "maxLength": 255,
      "description": "Sets the FNAME field."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the field's tag (see mailblaze_list_list_fields), e.g. {\"PHONE\": \"+1 555 0100\"}.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 1000
      }
    }
  }
}

mailblaze_add_subscribers_bulk

WRITE, MAY SEND CONFIRMATION EMAILS: add up to 100 subscribers to a mailing list in one request; an email already on the list is updated instead. Depending on the list's settings Mail Blaze may send confirmation emails. Only add people who agreed to receive your email.

destructive

Argument	Type	Description
list_uid*	string
subscribers*	array	1 to 100 subscribers.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "subscribers"
  ],
  "properties": {
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "subscribers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "email"
        ],
        "properties": {
          "email": {
            "type": "string",
            "pattern": "^[^\\s@<>\",;]+@[^\\s@<>\",;]+\\.[^\\s@<>\",;]+$",
            "maxLength": 254,
            "minLength": 3
          },
          "last_name": {
            "type": "string",
            "maxLength": 255
          },
          "first_name": {
            "type": "string",
            "maxLength": 255
          },
          "custom_fields": {
            "type": "object",
            "description": "Custom field values keyed by the field's tag (see mailblaze_list_list_fields), e.g. {\"PHONE\": \"+1 555 0100\"}.",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {
              "type": "string",
              "maxLength": 1000
            }
          }
        }
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "1 to 100 subscribers."
    }
  }
}

mailblaze_create_campaign

WRITE, SENDS EMAIL TO PEOPLE: create a campaign for a mailing list (or one of its segments) from an existing template and schedule it for send_at. Once it goes out it reaches every subscriber of the list or segment, may use sending credit and cannot be recalled. Confirm the list, segment, subject, template and send time with the user before calling. Needs a template uid (mailblaze_list_templates) and a list uid (mailblaze_list_lists).

destructive

Argument	Type	Description
name*	string	Internal campaign name.
send_at*	string	When to send, 'YYYY-MM-DD HH:MM:SS' (interpreted by Mail Blaze in the account's time zone).
subject*	string
list_uid*	string
reply_to*	string
from_name*	string
from_email*	string	Sender address; it must be a verified sender in Mail Blaze.

mailblaze_create_template

WRITE: create an email template from HTML (the tool base64-encodes it). Mail Blaze requires the HTML to contain an unsubscribe link. Sends nothing.

Argument	Type	Description
html*	string	The full HTML of the email, including an unsubscribe link.
name*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "html"
  ],
  "properties": {
    "html": {
      "type": "string",
      "maxLength": 1000000,
      "minLength": 1,
      "description": "The full HTML of the email, including an unsubscribe link."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1
    }
  }
}

mailblaze_find_subscriber_by_email

Look up a subscriber in one list by email address. Returns the subscriber (with its uid) or a not-found error.

read-only

Argument	Type	Description
email*	string
list_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "pattern": "^[^\\s@<>\",;]+@[^\\s@<>\",;]+\\.[^\\s@<>\",;]+$",
      "maxLength": 254,
      "minLength": 3
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_get_campaign

Get one campaign by uid: sender, subject, list, template, status and schedule.

read-only

Argument	Type	Description
campaign_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "campaign_uid"
  ],
  "properties": {
    "campaign_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_get_campaign_inbox_breakdown

Inbox-provider breakdown (e.g. Gmail, Outlook, Yahoo) of a campaign's delivery.

read-only

Argument	Type	Description
campaign_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "campaign_uid"
  ],
  "properties": {
    "campaign_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_get_campaign_summaries

Bulk report summary (sent, opens, clicks, bounces, unsubscribes) for up to 50 campaigns in one call. Read-only (it is a POST in the API only because of the id list).

read-only

Argument	Type	Description
campaign_uids*	array	1 to 50 campaign uids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "campaign_uids"
  ],
  "properties": {
    "campaign_uids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_-]+$",
        "maxLength": 64,
        "minLength": 1
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "1 to 50 campaign uids."
    }
  }
}

mailblaze_get_list

Get one mailing list by its uid: general settings, default sender, company details and counts.

read-only

Argument	Type	Description
list_uid*	string	List uid from mailblaze_list_lists.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid"
  ],
  "properties": {
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "List uid from mailblaze_list_lists."
    }
  }
}

mailblaze_get_report_job

Status (and result when finished) of an asynchronous report job, as returned in a 202 reply with a job_id.

read-only

Argument	Type	Description
job_id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 128,
      "minLength": 1
    }
  }
}

mailblaze_get_subscriber

Get one subscriber of a list by subscriber uid (status, fields, dates).

read-only

Argument	Type	Description
list_uid*	string
subscriber_uid*	string	Subscriber uid from mailblaze_list_subscribers or mailblaze_find_subscriber_by_email.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "subscriber_uid"
  ],
  "properties": {
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "subscriber_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1,
      "description": "Subscriber uid from mailblaze_list_subscribers or mailblaze_find_subscriber_by_email."
    }
  }
}

mailblaze_get_subscriber_activity

Email activity (sends, opens, clicks, bounces) of one subscriber by email address, optionally limited to one list. Cursor-paged.

read-only

Argument	Type	Description
email*	string
limit	integer	Events per page (default 100, max 1000).
cursor	string	The next_cursor from the previous reply, passed back exactly as returned. Omit for the first page.
list_uid	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "pattern": "^[^\\s@<>\",;]+@[^\\s@<>\",;]+\\.[^\\s@<>\",;]+$",
      "maxLength": 254,
      "minLength": 3
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Events per page (default 100, max 1000)."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "The next_cursor from the previous reply, passed back exactly as returned. Omit for the first page."
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_get_template

Get one email template by uid (name and content).

read-only

Argument	Type	Description
template_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "template_uid"
  ],
  "properties": {
    "template_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_get_transactional_email

Get one transactional email by uid: recipient, subject, status and timestamps.

read-only

Argument	Type	Description
email_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "email_uid"
  ],
  "properties": {
    "email_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_list_campaign_events

List the individual events of a campaign by kind: opens, clicks, bounces or unsubscribes. Cursor-paged: pass the reply's next_cursor back until it is null. For very large campaigns Mail Blaze answers 202 with a job_id; check it with mailblaze_get_report_job.

read-only

Argument	Type	Description
kind*	string
limit	integer	Events per page (default 100, max 1000).
cursor	string	The next_cursor from the previous reply, passed back exactly as returned. Omit for the first page.
campaign_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "campaign_uid",
    "kind"
  ],
  "properties": {
    "kind": {
      "enum": [
        "opens",
        "clicks",
        "bounces",
        "unsubscribes"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Events per page (default 100, max 1000)."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "The next_cursor from the previous reply, passed back exactly as returned. Omit for the first page."
    },
    "campaign_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_list_campaigns

List the account's email campaigns (uid, name, status, dates). Use the campaign uid for details and reports.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    }
  }
}

mailblaze_list_list_fields

List the fields of a mailing list (label, tag, type, required). The tags (EMAIL, FNAME, LNAME, custom ones) are the keys used when adding or updating subscribers.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).
list_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_list_lists

List the account's mailing lists (name, uid, subscriber counts, defaults). Use the list uid in the other tools. Paged: page + per_page.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).
per_page	integer	Lists per page (default set by Mail Blaze).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Lists per page (default set by Mail Blaze)."
    }
  }
}

mailblaze_list_segments

List the segments defined on a mailing list (uid, name). A segment uid can be used when creating a campaign.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).
list_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_list_subscribers

List the subscribers of a mailing list (sets of 10 per page; use page to go on). Contains personal data (emails, names).

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).
list_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_list_templates

List the account's email templates (uid, name). A template uid is needed to create a campaign.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    }
  }
}

mailblaze_list_transactional_emails

List the transactional emails sent through the account (uid, recipient, subject, status). Paged.

read-only

Argument	Type	Description
page	integer	Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number, starting at 1 (results come in sets of 10; keep going until a page comes back empty)."
    }
  }
}

mailblaze_resubscribe_subscriber

WRITE: set a previously unsubscribed subscriber back to subscribed so campaigns reach them again. Only do this when the person asked to be re-added (consent).

destructive

Argument	Type	Description
list_uid*	string
subscriber_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "subscriber_uid"
  ],
  "properties": {
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "subscriber_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_send_transactional_email

WRITE, SENDS ONE EMAIL NOW: send a single one-to-one email to one recipient through Mail Blaze. It leaves immediately, uses sending credit and cannot be recalled. Give either html (the body) or template_id (a transactional template, with merge_tags covering every tag in it), not both. Confirm the recipient and content with the user before calling. Not for bulk or marketing mail; use a campaign for that.

destructive

Argument	Type	Description
html	string	HTML body (the tool base64-encodes it). Omit when using template_id.
subject*	string
to_name*	string	Recipient name (required by Mail Blaze).
to_email*	string
from_name*	string	Sender name (required by Mail Blaze).
from_email*	string	Sender address; it must be a verified sender in Mail Blaze.
merge_tags	object	Template merge tags (required with template_id); every tag in the template must be present.

mailblaze_unsubscribe_subscriber

WRITE: set a subscriber's status to unsubscribed so they receive no more campaigns from this list. By default Mail Blaze also adds the address to the account's local blacklist. Do this only when the person asked to stop (or a data-protection request requires it). The subscriber record is kept.

destructive

Argument	Type	Description
list_uid*	string
subscriber_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "subscriber_uid"
  ],
  "properties": {
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "subscriber_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

mailblaze_update_subscriber

WRITE: update a subscriber's name or custom fields. Pass the subscriber's current email (Mail Blaze requires it) plus only the values to change. Does not change subscription status.

destructive

Argument	Type	Description
email*	string	The subscriber's email (Mail Blaze requires it on update).
list_uid*	string
last_name	string
first_name	string
custom_fields	object	Custom field values keyed by the field's tag (see mailblaze_list_list_fields), e.g. {"PHONE": "+1 555 0100"}.
subscriber_uid*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "list_uid",
    "subscriber_uid",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "pattern": "^[^\\s@<>\",;]+@[^\\s@<>\",;]+\\.[^\\s@<>\",;]+$",
      "maxLength": 254,
      "minLength": 3,
      "description": "The subscriber's email (Mail Blaze requires it on update)."
    },
    "list_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    },
    "last_name": {
      "type": "string",
      "maxLength": 255
    },
    "first_name": {
      "type": "string",
      "maxLength": 255
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the field's tag (see mailblaze_list_list_fields), e.g. {\"PHONE\": \"+1 555 0100\"}.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "subscriber_uid": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]+$",
      "maxLength": 64,
      "minLength": 1
    }
  }
}

Mail Blaze MCP by usefulapi

Try it

mailblaze_add_subscriber Destructive

Mail Blaze MCP by usefulapi

Try it

mailblaze_add_subscriber Destructive

Tools (26)