Send to All using the Mailer API
POST to https://api.madmimi.com/mailer/to_all
with the following parameters
promotion_name
Required. The name of the promotion Mimi will send. For raw_html
or raw_plain_text
promotions, Mimi will automatically create or update the promotion in your account.
subject
The subject of the email. Will default to the promotion_name
if not supplied.
from
The from address. Just the email address or in Display Name <email@domain.com>
format.
raw_html
The custom HTML to send. Can be used on its own or in conjunction with raw_plain_text
.
raw_plain_text
The custom plain text to send. Can be used on its own or in conjunction with raw_html
.
track_links
Enable or disable link tracking in HTML promotions (default: on).
track_views
Enable or disable view tracking in non-custom HTML promotions (default: on).
prevent_resend
Ensure that audience member who has already received this promotion does not receive it again (default: off).
hidden
Creates the promotion as a hidden promotion so as not to clutter up your web interface (default: off)
body
Required if you have placeholders. "YAML" encoded replacements for any {placeholders}
in your promotion.
Macros
Because you are sending to a list you will need to include the [[unsubscribe]]
(or [[opt_out]]
alias) macro with @raw_html@ and @raw_plain_text@. If you are using @raw_html@ you will also need to include the [[tracking_beacon]]
(or [[peek_image]]
alias) macro.
Boolean parameters
For the boolean parameters like track_links
you can use true
, on
, or yes
for the affirmative, and false
, off
or no
otherwise.
Response
The API will respond with a unique mailing id if successful.