Broadcasts

Create a broadcast

Creates a broadcast to a segment, and schedules it when send is true.

post/broadcasts

Request

  • Base URL: https://api.mepmail.dev
  • URL: https://api.mepmail.dev/broadcasts
  • Auth: HTTP bearer

Request body

namestring

Internal name shown in the dashboard

segment_idstring uuid

Segment to send to; omitted means every contact of the team

fromstring required

Sender, "Name user@domain"; the domain must be verified for the team

subjectstring required

Subject line; supports {{{FIRST_NAME|there}}} merge fields

htmlstring

HTML body; include {{{UNSUBSCRIBE_URL}}} for the opt-out link

textstring

Plain-text body; at least one of html/text is required

preview_textstring

Inbox preview (preheader) text

topic_idstring uuid nullable

Topic id; only contacts subscribed to it receive the broadcast

sendboolean

true sends (or schedules) immediately instead of saving a draft

scheduled_atstring

Deliver later (requires send: true): ISO 8601 with offset or relative like "in 1 hour"

Response

Broadcast created (and scheduled when send: true)

idstring uuid required
finishes_atstring nullable

When the last email is expected to go out (ISO 8601); null when unknown

estimatedtrue

finishes_at is an estimate that moves as other sends come in

Changes

No recorded changes to this operation across all 1 revision of this API.