rapidmail_list_recipientlists
List recipient lists
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.
Parameterspage
rapidmail_get_recipientlist
Get recipient list
One recipient list by id. GET /recipientlists/{id}.
Parametersrecipientlist_idrequired
rapidmail_get_recipientlist_activity_stats
Get recipient list 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.
Parameterstorequiredfromrequiredrecipientlist_idrequired
rapidmail_list_recipients
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.
Parameterspageemailstatussort_byforeign_idsort_orderinclude_extrabigrecipientlist_idrequired
rapidmail_get_recipient
Get recipient
One recipient by id: e-mail, name, status, custom fields and timestamps. GET /recipients/{id}.
Parametersrecipient_idrequired
rapidmail_create_recipient
Add 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.
Parameterszipemailrequiredtitleextra1extra2extra3extra4extra5extra6extra7extra8extra9+10 more
rapidmail_update_recipient
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}.
Parameterszipemailtitleextra1extra2extra3extra4extra5extra6extra7extra8extra9+8 more
rapidmail_unsubscribe_recipient
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}.
Parametersrecipient_idrequired
rapidmail_list_mailings
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.
Parameterspagestatussent_tosort_bysent_fromsort_ordercreated_sinceupdated_sincerecipientlist_id
rapidmail_get_mailing
Get mailing
One mailing by id: status, subject, sender, destinations (recipient lists), send time, size and attachments. GET /mailings/{id}.
Parametersmailing_idrequired
rapidmail_get_mailing_stats
Get mailing statistics
Statistics of one sent mailing (opens, clicks, bounces, unsubscriptions and similar totals). GET /mailings/{id}/stats.
Parametersmailing_idrequired
rapidmail_list_mailing_activity
List mailing recipient 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.
Parameterspagemailing_idrequired
rapidmail_get_mailing_recipient_activity
Get one recipient's activity in a mailing
Delivery and engagement details of one recipient of one mailing. GET /mailings/{id}/stats/activity/{mailingrecipient_id}.
Parametersmailing_idrequiredmailingrecipient_idrequired
rapidmail_list_mailing_folders
List mailing folders
The folders used to organise mailings, with id and name. GET /mailings/folders.
Takes no parameters.
rapidmail_list_blacklist
List blacklist entries
The account's blacklist: e-mail addresses, domains and patterns that never receive mailings, with their type, source and dates. GET /blacklist.
Parameterspagepatternpage_sizecreated_sinceupdated_since
rapidmail_list_transactional_emails
List transactional e-mails
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.
Parameterstofrompagestatusdate_tosubjectdate_fromproject_idhas_attachments