Skip to content

createBroadcast.md

Latest commit

 

History

History
39 lines (29 loc) · 957 Bytes

createBroadcast.md

File metadata and controls

39 lines (29 loc) · 957 Bytes
Raw

createBroadcast

Create a broadcast draft. from is required; set audience to { type: "all" } or { type: "list", id: "lst_…" }. Returns the broadcast with its id (bct_…). Send it with sendBroadcast.

HTTP: POST /api/broadcasts

Parameters

Field Type Required Description
name string
from string ✓
replyTo string
subject string
preview string
audience object
templateId string
html string
text string
footerAddress string

Returns

any

Example

res = mk.createBroadcast({
    "from": "news@app.mailkite.dev",
    "subject": "Launch week",
    "audience": [object Object],
    "html": "<h1>We shipped</h1>",
})

← All methods · Docs · mailkite.dev