rapidmail_create_recipient

WRITE: add ONE recipient (subscriber) to a recipient list. By default double opt-in is used: the recipient is created with status 'new' and rapidmail sends ONE confirmation e-mail to that address; they only receive newsletters after confirming. Set double_opt_in=false only if you hold the person's documented consent: the recipient is then stored as 'active' and no e-mail is sent (refused if the address was unsubscribed before). If a deleted recipient with the same address exists it is re-activated; an existing address returns a conflict error. Never use for bulk imports. POST /recipients.

destructive

Argument	Type	Description
zip	string	Postal code (max 7 characters).
email*	string	E-mail address of the recipient.
title	string	Academic title, e.g. Prof. Dr.
extra1	string	Custom field 1 (max 255 characters).
extra2	string	Custom field 2 (max 255 characters).
extra3	string	Custom field 3 (max 255 characters).
extra4	string	Custom field 4 (max 255 characters).
extra5	string	Custom field 5 (max 255 characters).
extra6	string	Custom field 6 (max 255 characters).
extra7	string	Custom field 7 (max 255 characters).
extra8	string	Custom field 8 (max 255 characters).
extra9	string	Custom field 9 (max 255 characters).
gender	string	Gender.
extra10	string	Custom field 10 (max 255 characters).
lastname	string	Last name.
mailtype	string	Preferred mail format.
birthdate	string	Birth date, yyyy-mm-dd.
firstname	string	First name.
test_mode	boolean	true: validate only, nothing is saved and no e-mail is sent.
foreign_id	string	Your own external id for this contact.
double_opt_in	boolean	true (default): status 'new' and a confirmation e-mail is sent to the address. false: status 'active', no e-mail (only with documented consent).
recipientlist_id*	integer	rapidmail recipient list id to add the recipient to.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recipientlist_id",
    "email"
  ],
  "properties": {
    "zip": {
      "type": "string",
      "maxLength": 7,
      "description": "Postal code (max 7 characters)."
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 255,
      "description": "E-mail address of the recipient."
    },
    "title": {
      "type": "string",
      "maxLength": 50,
      "description": "Academic title, e.g. Prof. Dr."
    },
    "extra1": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 1 (max 255 characters)."
    },
    "extra2": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 2 (max 255 characters)."
    },
    "extra3": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 3 (max 255 characters)."
    },
    "extra4": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 4 (max 255 characters)."
    },
    "extra5": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 5 (max 255 characters)."
    },
    "extra6": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 6 (max 255 characters)."
    },
    "extra7": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 7 (max 255 characters)."
    },
    "extra8": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 8 (max 255 characters)."
    },
    "extra9": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 9 (max 255 characters)."
    },
    "gender": {
      "enum": [
        "male",
        "female"
      ],
      "type": "string",
      "description": "Gender."
    },
    "extra10": {
      "type": "string",
      "maxLength": 255,
      "description": "Custom field 10 (max 255 characters)."
    },
    "lastname": {
      "type": "string",
      "maxLength": 255,
      "description": "Last name."
    },
    "mailtype": {
      "enum": [
        "text",
        "html"
      ],
      "type": "string",
      "description": "Preferred mail format."
    },
    "birthdate": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Birth date, yyyy-mm-dd."
    },
    "firstname": {
      "type": "string",
      "maxLength": 255,
      "description": "First name."
    },
    "test_mode": {
      "type": "boolean",
      "description": "true: validate only, nothing is saved and no e-mail is sent."
    },
    "foreign_id": {
      "type": "string",
      "maxLength": 255,
      "description": "Your own external id for this contact."
    },
    "double_opt_in": {
      "type": "boolean",
      "description": "true (default): status 'new' and a confirmation e-mail is sent to the address. false: status 'active', no e-mail (only with documented consent)."
    },
    "recipientlist_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail recipient list id to add the recipient to.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_mailing

One mailing by id: status, subject, sender, destinations (recipient lists), send time, size and attachments. GET /mailings/{id}.

read-only

Argument	Type	Description
mailing_id*	integer	rapidmail mailing id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mailing_id"
  ],
  "properties": {
    "mailing_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail mailing id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_mailing_recipient_activity

Delivery and engagement details of one recipient of one mailing. GET /mailings/{id}/stats/activity/{mailingrecipient_id}.

read-only

Argument	Type	Description
mailing_id*	integer	rapidmail mailing id.
mailingrecipient_id*	integer	The mailing-recipient id from rapidmail_list_mailing_activity.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mailing_id",
    "mailingrecipient_id"
  ],
  "properties": {
    "mailing_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail mailing id.",
      "exclusiveMinimum": 0
    },
    "mailingrecipient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The mailing-recipient id from rapidmail_list_mailing_activity.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_mailing_stats

Statistics of one sent mailing (opens, clicks, bounces, unsubscriptions and similar totals). GET /mailings/{id}/stats.

read-only

Argument	Type	Description
mailing_id*	integer	rapidmail mailing id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mailing_id"
  ],
  "properties": {
    "mailing_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail mailing id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_recipient

One recipient by id: e-mail, name, status, custom fields and timestamps. GET /recipients/{id}.

read-only

Argument	Type	Description
recipient_id*	integer	rapidmail recipient id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recipient_id"
  ],
  "properties": {
    "recipient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail recipient id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_recipientlist

One recipient list by id. GET /recipientlists/{id}.

read-only

Argument	Type	Description
recipientlist_id*	integer	rapidmail recipient list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recipientlist_id"
  ],
  "properties": {
    "recipientlist_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail recipient list id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_get_recipientlist_activity_stats

Subscription activity of one recipient list between two dates (for example new subscriptions and unsubscriptions). The range may be at most one year, must not start before the list was created and must not lie in the future. GET /recipientlists/{id}/stats/activity.

read-only

Argument	Type	Description
to*	string	End date, yyyy-mm-dd; later than from.
from*	string	Start date, yyyy-mm-dd.
recipientlist_id*	integer	rapidmail recipient list id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recipientlist_id",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "End date, yyyy-mm-dd; later than from."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Start date, yyyy-mm-dd."
    },
    "recipientlist_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail recipient list id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_list_blacklist

The account's blacklist: e-mail addresses, domains and patterns that never receive mailings, with their type, source and dates. GET /blacklist.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
pattern	string	Only entries matching this pattern.
page_size	integer	Entries per page, 1-1000 (default 25).
created_since	string	Only entries created since this date/time.
updated_since	string	Only entries updated since this date/time.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "pattern": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Only entries matching this pattern."
    },
    "page_size": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Entries per page, 1-1000 (default 25)."
    },
    "created_since": {
      "type": "string",
      "description": "Only entries created since this date/time."
    },
    "updated_since": {
      "type": "string",
      "description": "Only entries updated since this date/time."
    }
  }
}

rapidmail_list_mailing_activity

The recipients a mailing went to and what each did (delivered, opened, clicked, bounced). Detailed event information is only available if the respective plugin is enabled in the rapidmail account. GET /mailings/{id}/stats/activity.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
mailing_id*	integer	rapidmail mailing id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mailing_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "mailing_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail mailing id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_list_mailing_folders

The folders used to organise mailings, with id and name. GET /mailings/folders.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

rapidmail_list_mailings

List newsletters (mailings) with status, subject, sender, send time, recipient count and recipient lists. Filter by status, recipient list, created / updated / sent date. Read only: mailings are never created, sent or scheduled by this server. GET /mailings.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
status	string	Mailing status, e.g. draft, scheduled, sending, sent.
sent_to	string	Only mailings sent up to this date/time (after sent_from).
sort_by	string	Sort field.
sent_from	string	Only mailings sent from this date/time.
sort_order	string	Sort direction.
created_since	string	Only mailings created since this date/time.
updated_since	string	Only mailings updated since this date/time.
recipientlist_id

rapidmail_list_recipientlists

List the recipient lists (newsletter audiences) of the rapidmail account with id, name, description, whether unsubscribed recipients are blacklisted, and which is the default. Use the ids for recipients and mailing filters. GET /recipientlists.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_list_recipients

List the recipients (subscribers) of ONE recipient list, optionally filtered by e-mail address, external id or status. recipientlist_id is required. The long text fields (extrabig1-10) are only returned with include_extrabig. GET /recipients.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
email	string	Only the recipient with this e-mail address.
status	array	Only recipients in these statuses: new (awaiting confirmation), active, bounced, abused, deleted.
sort_by	string	Sort field.
foreign_id	string	Only the recipient with this external id.
sort_order	string	Sort direction.
include_extrabig	boolean	Also return the long text fields extrabig1-10 (default false).
recipientlist_id*	integer	rapidmail recipient list id (see rapidmail_list_recipientlists).

rapidmail_list_transactional_emails

Transactional (SMTP) e-mails sent through the rapidmail account: sender, recipient, subject, status (queued, delivered, bounced...), delivery diagnostics and open/click counts. Metadata only, no message bodies. Filter by date, status, project or address. GET /trx/emails.

read-only

Argument	Type	Description
to	string	Recipient name or address.
from	string	Sender name or address.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
status	array	Only these delivery statuses.
date_to	string	To date, yyyy-mm-dd.
subject	string	Subject text.
date_from	string	From date, yyyy-mm-dd (not older than the account's retention).
project_id	array	Only these transactional-mail project ids.
has_attachments	boolean

rapidmail_unsubscribe_recipient

WRITE: remove ONE recipient from their list. rapidmail only soft-deletes the record (status 'deleted', as if the person had unsubscribed) and the statistics count it as an unsubscription. No goodbye e-mail is sent. Single recipient only. DELETE /recipients/{id}.

destructive

Argument	Type	Description
recipient_id*	integer	rapidmail recipient id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "recipient_id"
  ],
  "properties": {
    "recipient_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "rapidmail recipient id.",
      "exclusiveMinimum": 0
    }
  }
}

rapidmail_update_recipient

WRITE: partially update ONE recipient (only the fields you pass change): e-mail, name, custom fields. The status and the recipient list cannot be changed here, and no e-mail is sent. An e-mail address that already exists in the list returns a conflict error. PATCH /recipients/{id}.

destructive

Argument	Type	Description
zip	string	Postal code (max 7 characters).
email	string	New e-mail address.
title	string	Academic title, e.g. Prof. Dr.
extra1	string	Custom field 1 (max 255 characters).
extra2	string	Custom field 2 (max 255 characters).
extra3	string	Custom field 3 (max 255 characters).
extra4	string	Custom field 4 (max 255 characters).
extra5	string	Custom field 5 (max 255 characters).
extra6	string	Custom field 6 (max 255 characters).

rapidmail MCP by usefulapi

Try it

rapidmail_create_recipient Destructive

rapidmail MCP by usefulapi

Try it

rapidmail_create_recipient Destructive

Tools (16)