Plumail

Sends a single (transactional) email to one or more addresses. The sender must belong to a verified domain of the workspace — call get_account to see which ones. An address suppressed for a bounce, a complaint or by hand fails the entire call, with its reason. An unsubscribed address still gets an individual email (a reply, an invoice, an appointment); a newsletter or a prospecting email must carry `unsubscribe_url`, and is then refused to an unsubscribed address. At most 50 addresses in all, to, cc and bcc together. Every address (to, cc, bcc) counts against the plan's monthly quota: past it, the call is refused (`quota_exceeded`) with the figures and the reset date — do not retry before that date. The email is sent immediately: this action cannot be undone.

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "description": "Sending address on a verified domain. \"Name <[email protected]>\" format accepted."
    },
    "to": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 50
        }
      ],
      "description": "Recipient, or list of recipients."
    },
    "subject": {
      "type": "string",
      "description": "Message subject."
    },
    "html": {
      "type": "string",
      "description": "HTML body."
    },
    "text": {
      "type": "string",
      "description": "Plain-text body. At least one of html or text is required."
    },
    "replyTo": {
      "type": "string",
      "description": "Reply-to address."
    },
    "unsubscribe_url": {
      "type": "string",
      "description": "One-click unsubscribe https address. Required for a newsletter or a prospecting email: it makes the send refused to an unsubscribed address. Leave it out for an individual email."
    }
  },
  "required": [
    "from",
    "to",
    "subject"
  ]
}

Returns the workspace this key grants access to, its scopes, plan, remaining emails this month (queued sends included), when the counter resets, billing status, member and domain limits, sending domains (verified or not) and registered senders. Call this FIRST: it tells you which address to send from before attempting anything.

{
  "type": "object",
  "properties": {}
}

Lists the workspace's subscribers, page by page. Use `cursor` with the `next_cursor` value from the response to get the next page. `status` filters on subscribed, pending, unsubscribed, bounced, or complained.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number",
      "description": "1 to 100, 50 by default."
    },
    "cursor": {
      "type": "string",
      "description": "Next-page cursor."
    },
    "status": {
      "type": "string"
    },
    "q": {
      "type": "string",
      "description": "Search by address or name."
    },
    "updated_since": {
      "type": "string",
      "description": "ISO 8601 date: only the records created or changed since then (status, name, fields, tags)."
    }
  }
}

Adds or updates a subscriber. By default the person enters as PENDING and receives a confirmation email: that is double opt-in, and it protects the workspace's sending reputation. `double_opt_in: false` subscribes directly and must only be used when consent was already collected elsewhere — never on your own initiative. A suppressed or unsubscribed address is refused. An address gets at most one confirmation every 2 minutes and 3 per 24 hours: do not retry in a loop, read `confirmation_not_sent_reason` and `confirmation_retry_at` in the response.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "double_opt_in": {
      "type": "boolean",
      "description": "false = direct subscription without confirmation. Only request this on explicit instruction from the person."
    }
  },
  "required": [
    "email"
  ]
}

Unsubscribes an address and adds it to the workspace's suppression list: no more campaigns, automations, or sends carrying `unsubscribe_url`. The record is not deleted — that is what prevents the address from coming back on the next file import. This action cannot be reversed via the API: only the person can re-subscribe.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}

The workspace's tags, with how many subscribers carry each one (`subscribers`) and, among them, the active ones (`subscribed`). Read this before tagging: reuse an existing name rather than creating a near-duplicate.

{
  "type": "object",
  "properties": {}
}

Adds (`add`) and removes (`remove`) tags on ONE existing subscriber, and nothing else: no subscription, no confirmation email, no status touched. Prefer it to add_subscriber for changing tags: add_subscriber is a subscription and sends the confirmation again to a pending person. An unknown address is not created (404). The response says what really changed (`added`, `removed`).

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "add": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "remove": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "email"
  ]
}

Erases a person from the workspace at THEIR request (right to erasure): record, name, fields, proof of consent, tags. Statistics of campaigns already sent do not move; the suppression list is not touched. To stop someone receiving anything, use remove_subscriber — not this one. IRREVERSIBLE: only use it on the explicit request of the person concerned, relayed by the user.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}

Suppressed addresses, with their reason: bounced, complained or manually suppressed (nothing goes to them), or unsubscribed (no more campaigns, automations, or sends carrying `unsubscribe_url`, but an individual email still reaches them). The `scope` field tells whether the address is suppressed for this workspace only or for the entire platform. No tool removes an address from this list: that action is done manually in the Mailcheer workspace, because it is the one that can suspend a sending capability.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "cursor": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "description": "Look up a specific address."
    }
  }
}

Adds an address to the workspace's suppression list. By default (`manual`), it will receive nothing further, neither campaigns nor individual emails; with `unsubscribe`, only campaigns, automations, and sends carrying `unsubscribe_url` are refused to it. Use when someone requests no further contact outside the unsubscribe link.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "reason": {
      "type": "string",
      "enum": [
        "unsubscribe",
        "bounce",
        "complaint",
        "manual"
      ]
    }
  },
  "required": [
    "email"
  ]
}

The workspace's campaigns, from newest to oldest, with their status: draft, scheduled, sending, or sent.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "number"
    },
    "cursor": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  }
}

Creates a DRAFT. Nothing is sent: you then need to call send_campaign, or send it from the Mailcheer workspace. Content is written in plain text in `text` — a blank line separates paragraphs, "#" at the start of a line makes a heading. Always have the draft reviewed before sending.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Internal name, visible only in the workspace."
    },
    "subject": {
      "type": "string",
      "description": "Subject line seen by recipients."
    },
    "text": {
      "type": "string",
      "description": "Plain-text content."
    },
    "preheader": {
      "type": "string",
      "description": "Preview text shown after the subject in the inbox."
    },
    "from": {
      "type": "string",
      "description": "Address of an already-registered sender. Defaults to the workspace sender."
    },
    "kind": {
      "type": "string",
      "description": "newsletter, offer, announcement… newsletter by default."
    }
  },
  "required": [
    "name"
  ]
}

Edits a DRAFT: name, subject, preheader, kind, sender, content (`text`). Nothing is sent. Prefer it to create_campaign to rework a text: otherwise the old draft stays in the list. A scheduled, sending or sent campaign cannot be edited (409).

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "subject": {
      "type": "string"
    },
    "text": {
      "type": "string",
      "description": "The new content, in plain text: it replaces the old one."
    },
    "preheader": {
      "type": "string"
    },
    "from": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Read-only: nothing is sent. Returns exactly what send_campaign would do right now — would it go out (and if not, why), and how many people would receive it. With `to`, reports address by address who is kept and who is excluded, with the reason (unsubscribed, bounced, complained, not in the list…). If the monthly quota is not enough, `would_send` is false, `blocked_code` is `quota_exceeded` and `blocked_details` gives the figures and the reset date. Call it BEFORE send_campaign, and give that number to the person when you ask them to confirm.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Campaign identifier."
    },
    "to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional. The addresses to restrict the send to. Omitted = the campaign's whole audience."
    }
  },
  "required": [
    "id"
  ]
}

⚠️ IRREVERSIBLE. Locks the recipient list and triggers sending to ALL active subscribers in the workspace — or, with `to`, only to the requested addresses that are active subscribers (never an unsubscribed or suppressed address). A sent email cannot be recalled. First call preview_campaign_send with the same parameters, then ask the person for explicit confirmation, telling them how many people will receive the message. Messages go out progressively; get_campaign_stats tracks progress.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Campaign identifier."
    },
    "to": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional. Restricts the send to these addresses. An empty list sends to nobody (refused); for the whole list, omit the field."
    }
  },
  "required": [
    "id"
  ]
}

Status and figures for a campaign: recipients, sent, delivered, opened, clicked, bounced, complained. Rates are calculated on delivered messages, not on recipients. Every rate comes twice: open_rate and click_rate include bots (security gateways, preloads), human_open_rate and human_click_rate set them aside — that is the figure to give the person when they ask how many read it.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Status of an email sent via send_email: sent, delivered, bounced, or complained. Amazon's delivery callback arrives a few seconds to a few minutes after sending — a "sent" status right after the call is normal.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}