Create Broadcast
meisa_create_broadcastCreate a new email broadcast in Meisa in draft status. A broadcast sends one email to many contacts matching an audience segment. Requires a name and a template_id (use meisa_list_templates to find one). The broadcast is created as a draft and must be sent with meisa_send_broadcast. Do NOT use for one-to-one transactional emails. Use meisa_send_email for those. Optionally enable Warm Send (warm_send_enabled) to deliver in engagement-ranked chunks spaced over up to 24 hours. Top openers receive the email first, which protects sender reputation on large or low-engagement lists. Pass a non-empty subject_override_b to enable a 50/50 subject-line A/B test on this broadcast. Each recipient deterministically receives one variant (hashed by recipient + broadcast id) and analytics include per-variant open and click rates. subject_override_b requires subject_override to also be set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Internal name for this broadcast (not shown to recipients). | |
| sender_id | No | UUID of the sender identity to use. If omitted, the product default sender is used. | |
| description | No | Internal description/notes about this broadcast. | |
| template_id | Yes | UUID of the email template to use. Use meisa_list_templates to find available templates. | |
| segment_query | No | Audience segment filter rules. Example: {"rules": [{"field": "status", "operator": "equals", "value": "active"}]}. If omitted, all active contacts are targeted. | |
| email_category | Yes | REQUIRED. Which kind of email this broadcast is, so recipients can unsubscribe from just this kind: 'product_updates' (new features, improvements, important changes), 'promotions' (offers, discounts, sales, launches with a deal), 'newsletter' (regular articles and news), 'onboarding' (tips and onboarding). Unsubscribing from one category never stops the others. Pick 'product_updates' when unsure. | |
| subject_override | No | Override the template's subject line for this broadcast. | |
| warm_send_enabled | No | Enable Warm Send for this broadcast. When true, the audience is split into chunks ordered by historical open engagement (top openers first) and the chunks fire over up to 24 hours. Recommended for sends larger than ~5,000 contacts or for re-engagement campaigns to lists that have not been emailed recently. Default false. | |
| subject_override_b | No | Optional second subject line. When set together with subject_override, the broadcast runs a 50/50 subject-line A/B test. Each recipient deterministically receives one of the two subjects. Requires subject_override to also be set. | |
| preview_text_override | No | Override the template's preview text (the snippet most email clients show next to the subject in the inbox). | |
| preview_text_override_b | No | Optional second preview text shown to recipients who receive subject variant B in an A/B test. Only used when subject_override_b is set. | |
| warm_send_chunk_gap_hours | No | Hours between Warm Send chunks. Default 8. Total send window is always capped at 24 hours, so very large gaps are auto-compressed. Only used when warm_send_enabled is true. |