/v1/blasts/{id}/dispatchSend a scheduled blast
Sends a blast, and is the only verb that does: it expands into one ordinary outbound message per audience address, each in that address's own thread with that recipient's merge fields filled, and the rail draining the outbox carries them. Body: medium (absent takes the blast's kind — "sms" for a text blast, "email" for an email one; a text blast may ask for "imessage" instead, and a crossed pair is refused); scheduleAt (an RFC3339 time, or "" for now — its presence launches a DRAFT in one step, freezing the audience and queueing every copy for that moment); pacing ({spreadMinutes, activeHoursStart, activeHoursEnd, activeHoursTimezone} — spread the copies over that many minutes and only inside those daily "HH:MM" hours in that IANA zone; it also launches a draft, and a pacing that cannot be planned is refused, never ignored); and limit (bounds one run of an already-scheduled blast; addresses past it are ledgered skipped; not allowed with scheduleAt or pacing). A recipient who opted out, or whose copy has a field with nothing to fill it and no fallback, is ledgered skipped with the reason and the rest still go. The copies leave on the blast's sendFrom line, or the workspace's default when it names none; the line is checked again here against what the caller may send from. IDEMPOTENT: a blast already dispatched is answered from its ledger with created: 0, so a retried request cannot message an audience twice. Read get_blasts_id_preview first. A blast is timed by scheduleAt or pacing here, never by a wait in the caller's own loop, and nothing has been sent or scheduled until this or post_blasts_id_schedule has answered. This is the many-people send; post_comms_send is the one-person one.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"audience": 1,
"blastId": 1,
"created": 1,
"medium": "string",
"states": {},
"status": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}